Skip to content
AdCrunch
Esc
↑↓navigate↵open⌘Jpreview

Add a Creative to a Campaign Plan

Puts a Creative of the Library into the pool of a Campaign Plan. A Campaign Plan holds a pool of Creatives of the Library, at most 50. Each Line Item of the plan picks its Creatives from the pool, at most 20. The ads of a Line Item are built from the Creatives of that Line Item only. A Creative of the pool that no Line Item uses is not assigned yet.

Adding a Creative that is in the pool already changes nothing. A Creative with no Variation is valid. The Creative is not on a Line Item after this call: add it to a Line Item with POST /campaign-plans/{slug}/line-items/{lineItemId}/creatives. The call does not change the revision or the status of the Campaign Plan or of a Line Item. A validated Line Item stays validated.

POST/context/campaign-plans/{slug}/creatives
Authorization
AuthorizationBearer token · headerrequired

Send Authorization: Bearer <credential>.

Use an API key (acr_…), from the AdCrunch console under Settings → API keys.

The credential names the organization, and no operation takes an organization parameter.

See https://docs.adcrunch.dev/api/authentication.

Path parameters
slugstringrequired
Request body
requiredapplication/json
creativeIdstringrequired

The id of a Creative in the Library of your organization, crv_…. List the Creatives with GET /library/creatives.

matches ^crv_[\s\S]{0,}$
Responses
200

The Creatives of the pool after the call, oldest first, each with the Line Items that use it.

creativesobject[]required

The Creatives of the pool after the call, oldest first, at most 50. A Creative that the Library deleted is not listed.

Show properties
Array of object
idstringrequired

The id of the Creative in the Library, crv_….

namestring | nullrequired

The name of the Creative, or null when nobody named it.

variationCountnumberrequired

The number of Variations of the Creative. Read them with GET /library/creatives/{creativeId}.

lineItemIdsstring[]required

The ids of the live Line Items of the plan that use the Creative. Empty when the Creative is not assigned to a Line Item yet.

400

The request does not match the schema of this operation: a field is missing or has the wrong type, or the body is not valid JSON. error is invalid_request, and issues names each field. Nothing was changed.

issuesobject[]required

One entry for each field that does not match.

Show properties
Array of object
instringrequired

The part of the request that holds the field.

Allowed:bodycookieheadersparamsquery
messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

pathstringrequired

A JSON Pointer into that part of the request, such as /filename. An empty string is the whole part.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

Allowed:invalid_request
messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

401

No API key, or one that does not resolve. See the security scheme. error is unauthorized.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

Allowed:unauthorized
messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

402

The organization has no active subscription. An owner subscribes at paywallUrl. error is organization_unentitled.

paywallUrlstring<uri>required

The page where an owner of the organization subscribes. Show it to the person.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

Allowed:organization_unentitled
messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

403

The caller does not hold campaign_plan:write. error is forbidden.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

Allowed:forbidden
messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

404

No Campaign Plan with that slug, or no Creative with that id in the Library of your organization. A deleted Creative and the Creative of another organization are not found. error is not_found, and message names which one.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

409

The pool has 50 Creatives already. error is creative_limit.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

Request
curl -X POST 'https://api.pr-1337.adcrunch.dev/context/campaign-plans/string/creatives' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "creativeId": "crv_8c2e47"
}'
Response
{
  "creatives": [
    {
      "id": "crv_8c2e47",
      "lineItemIds": [],
      "name": "Spring sale",
      "variationCount": 2
    }
  ]
}