Brands API

Create brands

A brand is a media brand that belongs to a media partner (typically the advertiser company).

POST /v1/media-partners/{mediaPartnerId}/brands

Parameter	In	Required	Type	Description
`mediaPartnerId`	path	Yes	integer	The media partner (company) the brand belongs to.

Request body — CreateMediaBrandRequest

Field	Type	Required	Description
`name`	string	Yes	Brand name.
`externalKey`	string	No	Your own external reference key.
`subsystemExternalIds`	object (string → string)	No	External ids per subsystem.

{
  "name": "Acme Cola",
  "externalKey": "acme-cola",
  "subsystemExternalIds": {}
}

Responses

Status	Meaning
`201`	Media brand created.
`400`	Invalid input.
`401` / `403`	Not authenticated / not allowed.
`404`	Media partner not found.

As with companies, 201 will return a body including the generated id and all information known about the brand.

GET /v1/media-partners/{mediaPartnerId}/brands?limit=50&offset=0

Parameter	In	Required	Type	Description
`mediaPartnerId`	path	Yes	integer	The media partner.
`limit`	query	Yes	integer	Max number of results.
`offset`	query	Yes	integer	Results to skip.
`includeInactive`	query	No	boolean	Include deactivated brands.
`search`	query	No	string	URL-encoded, case-insensitive match on name.

Response — array of MediaBrand Schema

[
  {
    "id": 8801,
    "name": "Acme Cola",
    "externalKey": "acme-cola",
    "subsystemExternalIds": {},
    "active": true
  }
]

GET /v1/media-partners/{mediaPartnerId}/brands/{mediaBrandId}

Returns a single MediaBrand Schema.