Skip to main content
POST
Request a post's ad code

Authorizations

x-api-key
string
header
required

API key created in Dashboard → Settings → Developer

Path Parameters

id
string<uuid>
required

ID of the post

Query Parameters

scope
enum<string>
default:company

Choose the data scope. company (default) limits results to the API key company's data. agency includes the parent agency and its linked brands. scope=agency requires a parent agency key; other keys receive 403.

Available options:
company,
agency

Response

The post's code state after the call

id
string<uuid>
required
adCodeState
enum<string>
required

Where the post's code stands after the call

Available options:
ready,
not_verified,
waiting,
rejected,
expired,
brand_setup_required,
not_requested,
declined
requestOpened
boolean
required

True when this call opened the request. The creator is told then. False when the post already had a code, an open request, or a code its campaign requires