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

Update a Placement

Changes the name, the description or the rules of a Placement of your organization. A field that the body leaves out stays as it is. The rules are checked against the type that the Placement already has.

channel and type never change. The Placement can change while Variations name it. A global Placement cannot change: it answers 404.

PATCH/library/placements/{placementId}
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
placementIdstringrequired

The Placement id.

matches ^(plm_)[\s\S]{0,}$
Request body
requiredapplication/json
descriptionstring | null

The new description. Send null or an empty string to remove it. Leave it out to keep it.

max length 1000
namestring

The name, 1 to 80 characters. AdCrunch trims it. It must be unique, ignoring case, among the ones that your organization sees.

min length 1 · max length 80
rulesobject[]

The new list of rules. It replaces the whole list. Leave it out to keep the rules.

max items 20
Show properties
Array of object
One of:
object
operatorobjectrequired
Show properties
Any of:
object
conditionstringrequired
Allowed:eq
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:ne
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:lt
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:lte
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:gt
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:gte
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:in
valueinteger[]required
min items 1 · max items 50
typestringrequired
Allowed:width
object
operatorobjectrequired
Show properties
Any of:
object
conditionstringrequired
Allowed:eq
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:ne
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:lt
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:lte
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:gt
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:gte
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:in
valueinteger[]required
min items 1 · max items 50
typestringrequired
Allowed:height
object
operatorobjectrequired
Show properties
Any of:
object
conditionstringrequired
Allowed:eq
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:ne
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:lt
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:lte
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:gt
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:gte
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:in
valueinteger[]required
min items 1 · max items 50
typestringrequired
Allowed:size
object
operatorobjectrequired
Show properties
Any of:
object
conditionstringrequired
Allowed:eq
valueinteger[]required
min items 2 · max items 2
Show properties
Array of integer
Any of:
integer
integer
integer
integer
object
conditionstringrequired
Allowed:ne
valueinteger[]required
min items 2 · max items 2
Show properties
Array of integer
Any of:
integer
integer
integer
integer
object
conditionstringrequired
Allowed:lt
valueinteger[]required
min items 2 · max items 2
Show properties
Array of integer
Any of:
integer
integer
integer
integer
object
conditionstringrequired
Allowed:lte
valueinteger[]required
min items 2 · max items 2
Show properties
Array of integer
Any of:
integer
integer
integer
integer
object
conditionstringrequired
Allowed:gt
valueinteger[]required
min items 2 · max items 2
Show properties
Array of integer
Any of:
integer
integer
integer
integer
object
conditionstringrequired
Allowed:gte
valueinteger[]required
min items 2 · max items 2
Show properties
Array of integer
Any of:
integer
integer
integer
integer
object
conditionstringrequired
Allowed:in
valueinteger[][]required
min items 1 · max items 50
typestringrequired
Allowed:ratio
object
operatorobjectrequired
Show properties
Any of:
object
conditionstringrequired
Allowed:eq
valuestringrequired
min length 1 · max length 255
object
conditionstringrequired
Allowed:ne
valuestringrequired
min length 1 · max length 255
object
conditionstringrequired
Allowed:in
valuestring[]required
min items 1 · max items 50
typestringrequired
Allowed:mime
object
operatorobjectrequired
Show properties
Any of:
object
conditionstringrequired
Allowed:eq
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:ne
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:lt
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:lte
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:gt
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:gte
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:in
valueinteger[]required
min items 1 · max items 50
typestringrequired
Allowed:duration
Responses
200

The Placement, with the change.

channelstringrequired

The channel of a Line Item that the Placement belongs to. It never changes.

Allowed:metatiktoksnapchatgoogle_searchgoogle_pmaxgoogle_displayyoutubeprogrammatic_displaylinkedinx
createdAtnumberrequired

Milliseconds since the Unix epoch, UTC.

createdBystring | nullrequired

The user who created the Placement. null on a global row.

deletedAtnumber | nullrequired

Always null here. A deleted Placement is not answered.

descriptionstring | nullrequired

A free text. null when the Placement has none.

idstringrequired

The id of the Placement, plm_….

isGlobalbooleanrequired

true on a row that AdCrunch holds for every organization. You read it, and you cannot change or delete it.

namestringrequired

The name, 1 to 80 characters. It is unique, ignoring case, among the Placements of the channel that the organization sees.

organizationIdstring | nullrequired

The organization that owns the Placement. null on a global row.

paramsobjectrequired
Show properties
One of:
object
rulesobject[]required
max items 20
Show properties
Array of object
One of:
object
operatorobjectrequired
Show properties
Any of:
object
conditionstringrequired
Allowed:eq
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:ne
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:lt
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:lte
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:gt
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:gte
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:in
valueinteger[]required
min items 1 · max items 50
typestringrequired
Allowed:width
object
operatorobjectrequired
Show properties
Any of:
object
conditionstringrequired
Allowed:eq
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:ne
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:lt
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:lte
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:gt
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:gte
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:in
valueinteger[]required
min items 1 · max items 50
typestringrequired
Allowed:height
object
operatorobjectrequired
Show properties
Any of:
object
conditionstringrequired
Allowed:eq
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:ne
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:lt
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:lte
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:gt
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:gte
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:in
valueinteger[]required
min items 1 · max items 50
typestringrequired
Allowed:size
object
operatorobjectrequired
Show properties
Any of:
object
conditionstringrequired
Allowed:eq
valueinteger[]required
min items 2 · max items 2
Show properties
Array of integer
Any of:
integer
integer
integer
integer
object
conditionstringrequired
Allowed:ne
valueinteger[]required
min items 2 · max items 2
Show properties
Array of integer
Any of:
integer
integer
integer
integer
object
conditionstringrequired
Allowed:lt
valueinteger[]required
min items 2 · max items 2
Show properties
Array of integer
Any of:
integer
integer
integer
integer
object
conditionstringrequired
Allowed:lte
valueinteger[]required
min items 2 · max items 2
Show properties
Array of integer
Any of:
integer
integer
integer
integer
object
conditionstringrequired
Allowed:gt
valueinteger[]required
min items 2 · max items 2
Show properties
Array of integer
Any of:
integer
integer
integer
integer
object
conditionstringrequired
Allowed:gte
valueinteger[]required
min items 2 · max items 2
Show properties
Array of integer
Any of:
integer
integer
integer
integer
object
conditionstringrequired
Allowed:in
valueinteger[][]required
min items 1 · max items 50
typestringrequired
Allowed:ratio
object
operatorobjectrequired
Show properties
Any of:
object
conditionstringrequired
Allowed:eq
valuestringrequired
min length 1 · max length 255
object
conditionstringrequired
Allowed:ne
valuestringrequired
min length 1 · max length 255
object
conditionstringrequired
Allowed:in
valuestring[]required
min items 1 · max items 50
typestringrequired
Allowed:mime
typestringrequired
Allowed:image
object
rulesobject[]required
max items 20
Show properties
Array of object
One of:
object
operatorobjectrequired
Show properties
Any of:
object
conditionstringrequired
Allowed:eq
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:ne
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:lt
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:lte
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:gt
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:gte
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:in
valueinteger[]required
min items 1 · max items 50
typestringrequired
Allowed:width
object
operatorobjectrequired
Show properties
Any of:
object
conditionstringrequired
Allowed:eq
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:ne
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:lt
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:lte
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:gt
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:gte
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:in
valueinteger[]required
min items 1 · max items 50
typestringrequired
Allowed:height
object
operatorobjectrequired
Show properties
Any of:
object
conditionstringrequired
Allowed:eq
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:ne
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:lt
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:lte
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:gt
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:gte
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:in
valueinteger[]required
min items 1 · max items 50
typestringrequired
Allowed:size
object
operatorobjectrequired
Show properties
Any of:
object
conditionstringrequired
Allowed:eq
valueinteger[]required
min items 2 · max items 2
Show properties
Array of integer
Any of:
integer
integer
integer
integer
object
conditionstringrequired
Allowed:ne
valueinteger[]required
min items 2 · max items 2
Show properties
Array of integer
Any of:
integer
integer
integer
integer
object
conditionstringrequired
Allowed:lt
valueinteger[]required
min items 2 · max items 2
Show properties
Array of integer
Any of:
integer
integer
integer
integer
object
conditionstringrequired
Allowed:lte
valueinteger[]required
min items 2 · max items 2
Show properties
Array of integer
Any of:
integer
integer
integer
integer
object
conditionstringrequired
Allowed:gt
valueinteger[]required
min items 2 · max items 2
Show properties
Array of integer
Any of:
integer
integer
integer
integer
object
conditionstringrequired
Allowed:gte
valueinteger[]required
min items 2 · max items 2
Show properties
Array of integer
Any of:
integer
integer
integer
integer
object
conditionstringrequired
Allowed:in
valueinteger[][]required
min items 1 · max items 50
typestringrequired
Allowed:ratio
object
operatorobjectrequired
Show properties
Any of:
object
conditionstringrequired
Allowed:eq
valuestringrequired
min length 1 · max length 255
object
conditionstringrequired
Allowed:ne
valuestringrequired
min length 1 · max length 255
object
conditionstringrequired
Allowed:in
valuestring[]required
min items 1 · max items 50
typestringrequired
Allowed:mime
object
operatorobjectrequired
Show properties
Any of:
object
conditionstringrequired
Allowed:eq
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:ne
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:lt
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:lte
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:gt
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:gte
valueintegerrequired
min 0 · max 9007199254740991
object
conditionstringrequired
Allowed:in
valueinteger[]required
min items 1 · max items 50
typestringrequired
Allowed:duration
typestringrequired
Allowed:video
typestringrequired

The kind of Asset that the slot takes. It never changes, and it equals params.type.

Allowed:imagevideo
updatedAtnumber | nullrequired

When the Placement last changed. null until its first update.

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. Or the rules do not fit the type of the Placement: a duration rule on an image. Then error is invalid_rules.

Any of:
object
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.

object
errorstringrequired

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

Allowed:invalid_rules
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 library: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 Placement of your organization with that id. A global Placement answers this too, because only AdCrunch changes one. error is not_found.

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

Another live Placement of the same channel that your organization sees holds this name, ignoring case. error is name_taken.

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 PATCH 'https://api.pr-1339.adcrunch.dev/library/placements/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "rules": [
    {
      "operator": {
        "condition": "eq",
        "value": [
          9,
          16
        ]
      },
      "type": "ratio"
    },
    {
      "operator": {
        "condition": "lte",
        "value": 15000
      },
      "type": "duration"
    }
  ]
}'
Response
{
  "channel": "meta",
  "createdAt": 1790000500000,
  "createdBy": "usr_2e5b84",
  "deletedAt": null,
  "description": "Our own cut for Reels, never over 30 seconds.",
  "id": "plm_4b8d27",
  "isGlobal": false,
  "name": "Reels short cut",
  "organizationId": "org_3a7f10",
  "params": {
    "rules": [
      {
        "operator": {
          "condition": "eq",
          "value": [
            9,
            16
          ]
        },
        "type": "ratio"
      },
      {
        "operator": {
          "condition": "lte",
          "value": 15000
        },
        "type": "duration"
      }
    ],
    "type": "video"
  },
  "type": "video",
  "updatedAt": 1790000900000
}

Was this page helpful?