Skip to content

Activate or pause an ad account

PATCH /api/marketing/ad-accounts/{id}

active enables it to operate from Neike, disabled pauses it without disconnecting it. Requires the marketing:manage scope.

FieldTypeDescription
statusactive · disabledrequiredactive enables it to operate from Neike; disabled pauses it without disconnecting it. An account with a revoked token must be reconnected through OAuth.
StatusDescriptionSchema
200—AdAccountDto
Terminal window
curl -X PATCH https://api.neike.dev/api/marketing/ad-accounts/{id} \
-H "x-neike-api-key: whk_live_…" \
-H "Content-Type: application/json" \
-d '{
"status": "active"
}'
FieldTypeDescription
idstringrequiredAccount id in Neike (uuid).
providermetarequiredAds provider of the account. Today there is only one: meta.
ad_account_idstringrequiredAccount id in Meta, with prefix. Example: "act_123456789".
account_idstringrequiredThe same id without the act_ prefix. Example: "123456789".
namestringrequiredExample: "Cuenta principal".
currencystringrequiredAccount currency in Meta. Example: "ARS".
timezone_namestringrequiredExample: "America/Argentina/Buenos_Aires".
account_statusnumberrequiredMeta numeric enum (1 = active, 2 = disabled…). Example: 1.
account_status_labelstringrequiredThe same status as text, already translated. Example: "active".
business_idstringoptional—
business_namestringoptional—
statusavailable · active · disabled · revokedrequiredStatus in Neike: available (connected, not yet chosen), active (operable), disabled (paused by the client) or revoked (Meta invalidated the token).
last_synced_atstring (date-time)required—
created_atstring (date-time)required—