Create an ad campaign
Starts an asynchronous campaign of static ad creatives, with the same choices as the campaign creator: a recipe or several ad types, an audience, angles and an optional brief (guided), or a brief alone (prompt).
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Optional caller-generated value that prevents duplicate generation when retrying the same request.
1 - 255Body
Mirrors the campaign creator. Guided mode (the default) starts, as the creator does, with the audience: audience_id is required, either a saved audience or null for a deliberately broad campaign. It then takes one recipe (blueprint_id) or several ad types (blueprint_ids), plus optional angles and a brief. With no recipe, one is chosen for the product, as in the app. Prompt mode takes a brief instead and has no audience step.
guided, prompt One recipe from GET /campaign-blueprints.
Several ad types for a custom campaign. The creatives are split evenly across them, so creative_count must be a multiple of the number of types.
1 - 30 elementsRequired in guided mode. A saved audience of the product, from GET /products/{product_id}/audiences, or null for a broad campaign. Prompt mode takes no audience (omit it or send null).
Angles for a single recipe, usually from POST /campaign-angles. Not allowed with blueprint_ids.
1 - 10 elements300Optional in guided mode. Required in prompt mode, where it is the whole direction.
1 - 2000Deprecated. The original prompt-only field: sending it means prompt mode with this brief, and keeps the original counts (3 to 30). Use mode: prompt and brief.
1 - 20001:1, 4:5, 9:16, 16:9 Defaults to the brand's saved language, else English.
English, Hindi, Hinglish, Tamil, Telugu, Marathi, Bengali, Kannada, Malayalam, Gujarati, Punjabi, Odia, Assamese, Urdu, Spanish, French, German, Portuguese, Italian, Dutch, Russian, Arabic, Mandarin Chinese, Japanese, Korean, Vietnamese, Thai, Indonesian, Filipino, Turkish, Polish, Ukrainian, Greek, Hebrew, Swedish, Norwegian, Danish, Finnish, Romanian, Czech, Hungarian, Swahili 5, 10, 15 or 20 (default 10). For blueprint_ids, a multiple of the number of ad types, up to 30 (default: the multiple nearest 10).
Refuse the request with 422 credit_limit_exceeded, before anything is charged, if it would cost more than this many credits.
x >= 1Response
Campaign accepted.
Net credits charged so far. Refunds for failed renders are subtracted.
queued, in_progress, completed, failed, canceled