Advertiser - Companies API
Create advertiser & invoicing companies
Both are created with the same endpoint; the roles array is what makes a company an advertiser, an invoicing party, or both.
Create a company
POST /v1/media-partners
Creates a media partner (advertiser company, invoicing company, or both, depending on roles).
Request body — CreateMediaPartnerRequest
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Display name of the company. |
roles | array of enum | Yes | Any of ADVERTISER, INVOICE |
externalKey | string | No | Your own external reference key. |
subsystemExternalIds | object (string → string) | No | External ids per subsystem. |
Create an advertiser company
{
"name": "Acme Beverages",
"roles": ["ADVERTISER"],
"externalKey": "acme-bev",
"subsystemExternalIds": {
"crm": "CRM-10432"
}
}
Create an invoicing company
{
"name": "Acme Beverages Billing BV",
"roles": ["INVOICE"],
"externalKey": "acme-bev-billing"
}
Create a company that is both advertiser and invoicing party
{
"name": "Acme Beverages",
"roles": ["ADVERTISER", "INVOICE"]
}
Responses
| Status | Meaning |
|---|---|
201 | Media partner created. |
400 | Invalid input (e.g. empty `name` or unknown role). |
401 / 403 | Not authenticated / not allowed. |
500 | Unexpected failure. |
The
201response will return a body including the generatedidand all information known about the media partner.
List companies
GET /v1/media-partners?limit=50&offset=0
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
limit | query | Yes | integer | Max number of results to return. |
offset | query | Yes | integer | Number of results to skip. |
search | query | No | string | URL-encoded, case-insensitive match on name. |
roles | query | No | array | Filter on the role(s) the media partner has, e.g. `roles=ADVERTISER`. |
includeInactive | query | No | boolean | Include deactivated media partners. |
Response — array of MediaPartner Schema
[
{
"id": 4021,
"name": "Acme Beverages",
"roles": ["ADVERTISER"],
"externalKey": "acme-bev",
"subsystemExternalIds": { "crm": "CRM-10432" },
"active": true
}
]
Get a single company
GET /v1/media-partners/{mediaPartnerId}
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
mediaPartnerId | path | Yes | integer | The id of the media partner. |
Returns a single MediaPartner Schema (same shape as above).