Add a Placement to a group
Adds a Placement to a group of your organization, and answers the group with its Placements. The Placement can be global or of your organization, of any channel. When the group already holds it, nothing changes and the answer is the same.
A global group cannot change: it answers 404.
/library/placement-groups/{groupId}/placementsAuthorizationBearer token · headerrequiredSend 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.
groupIdstringrequiredThe Placement group id.
application/jsonplacementIdstringrequiredThe Placement to add. It can be global or of your organization.
The group, with its Placements after the add.
createdAtnumberrequiredMilliseconds since the Unix epoch, UTC.
createdBystring | nullrequiredThe user who created the group. null on a global row.
deletedAtnumber | nullrequiredAlways null here. A deleted group is not answered.
descriptionstring | nullrequiredA free text. null when the group has none.
idstringrequiredThe id of the group, plg_….
isGlobalbooleanrequiredtrue on a row that AdCrunch holds for every organization. You read it, and you cannot change or delete it.
namestringrequiredThe name, 1 to 80 characters. It is unique, ignoring case, among the groups that the organization sees.
organizationIdstring | nullrequiredThe organization that owns the group. null on a global row.
updatedAtnumber | nullrequiredWhen the group last changed. null until its first update.
placementsobject[]requiredEvery live Placement that the group holds, with no page. A group holds at most the Placements that the organization sees.
Show propertiesHide properties
objectchannelstringrequiredThe channel of a Line Item that the Placement belongs to. It never changes.
metatiktoksnapchatgoogle_searchgoogle_pmaxgoogle_displayyoutubeprogrammatic_displaylinkedinxcreatedAtnumberrequiredMilliseconds since the Unix epoch, UTC.
createdBystring | nullrequiredThe user who created the Placement. null on a global row.
deletedAtnumber | nullrequiredAlways null here. A deleted Placement is not answered.
descriptionstring | nullrequiredA free text. null when the Placement has none.
idstringrequiredThe id of the Placement, plm_….
isGlobalbooleanrequiredtrue on a row that AdCrunch holds for every organization. You read it, and you cannot change or delete it.
namestringrequiredThe name, 1 to 80 characters. It is unique, ignoring case, among the Placements of the channel that the organization sees.
organizationIdstring | nullrequiredThe organization that owns the Placement. null on a global row.
paramsobjectrequiredShow propertiesHide properties
rulesobject[]requiredShow propertiesHide properties
objectoperatorobjectrequiredShow propertiesHide properties
conditionstringrequiredeqvalueintegerrequiredconditionstringrequirednevalueintegerrequiredconditionstringrequiredltvalueintegerrequiredconditionstringrequiredltevalueintegerrequiredconditionstringrequiredgtvalueintegerrequiredconditionstringrequiredgtevalueintegerrequiredconditionstringrequiredinvalueinteger[]requiredtypestringrequiredwidthoperatorobjectrequiredShow propertiesHide properties
conditionstringrequiredeqvalueintegerrequiredconditionstringrequirednevalueintegerrequiredconditionstringrequiredltvalueintegerrequiredconditionstringrequiredltevalueintegerrequiredconditionstringrequiredgtvalueintegerrequiredconditionstringrequiredgtevalueintegerrequiredconditionstringrequiredinvalueinteger[]requiredtypestringrequiredheightoperatorobjectrequiredShow propertiesHide properties
conditionstringrequiredeqvalueintegerrequiredconditionstringrequirednevalueintegerrequiredconditionstringrequiredltvalueintegerrequiredconditionstringrequiredltevalueintegerrequiredconditionstringrequiredgtvalueintegerrequiredconditionstringrequiredgtevalueintegerrequiredconditionstringrequiredinvalueinteger[]requiredtypestringrequiredsizeoperatorobjectrequiredShow propertiesHide properties
conditionstringrequiredeqvalueinteger[]requiredShow propertiesHide properties
integerintegerintegerconditionstringrequirednevalueinteger[]requiredShow propertiesHide properties
integerintegerintegerconditionstringrequiredltvalueinteger[]requiredShow propertiesHide properties
integerintegerintegerconditionstringrequiredltevalueinteger[]requiredShow propertiesHide properties
integerintegerintegerconditionstringrequiredgtvalueinteger[]requiredShow propertiesHide properties
integerintegerintegerconditionstringrequiredgtevalueinteger[]requiredShow propertiesHide properties
integerintegerintegerconditionstringrequiredinvalueinteger[][]requiredtypestringrequiredratiooperatorobjectrequiredShow propertiesHide properties
conditionstringrequiredeqvaluestringrequiredconditionstringrequirednevaluestringrequiredconditionstringrequiredinvaluestring[]requiredtypestringrequiredmimetypestringrequiredimagerulesobject[]requiredShow propertiesHide properties
objectoperatorobjectrequiredShow propertiesHide properties
conditionstringrequiredeqvalueintegerrequiredconditionstringrequirednevalueintegerrequiredconditionstringrequiredltvalueintegerrequiredconditionstringrequiredltevalueintegerrequiredconditionstringrequiredgtvalueintegerrequiredconditionstringrequiredgtevalueintegerrequiredconditionstringrequiredinvalueinteger[]requiredtypestringrequiredwidthoperatorobjectrequiredShow propertiesHide properties
conditionstringrequiredeqvalueintegerrequiredconditionstringrequirednevalueintegerrequiredconditionstringrequiredltvalueintegerrequiredconditionstringrequiredltevalueintegerrequiredconditionstringrequiredgtvalueintegerrequiredconditionstringrequiredgtevalueintegerrequiredconditionstringrequiredinvalueinteger[]requiredtypestringrequiredheightoperatorobjectrequiredShow propertiesHide properties
conditionstringrequiredeqvalueintegerrequiredconditionstringrequirednevalueintegerrequiredconditionstringrequiredltvalueintegerrequiredconditionstringrequiredltevalueintegerrequiredconditionstringrequiredgtvalueintegerrequiredconditionstringrequiredgtevalueintegerrequiredconditionstringrequiredinvalueinteger[]requiredtypestringrequiredsizeoperatorobjectrequiredShow propertiesHide properties
conditionstringrequiredeqvalueinteger[]requiredShow propertiesHide properties
integerintegerintegerconditionstringrequirednevalueinteger[]requiredShow propertiesHide properties
integerintegerintegerconditionstringrequiredltvalueinteger[]requiredShow propertiesHide properties
integerintegerintegerconditionstringrequiredltevalueinteger[]requiredShow propertiesHide properties
integerintegerintegerconditionstringrequiredgtvalueinteger[]requiredShow propertiesHide properties
integerintegerintegerconditionstringrequiredgtevalueinteger[]requiredShow propertiesHide properties
integerintegerintegerconditionstringrequiredinvalueinteger[][]requiredtypestringrequiredratiooperatorobjectrequiredShow propertiesHide properties
conditionstringrequiredeqvaluestringrequiredconditionstringrequirednevaluestringrequiredconditionstringrequiredinvaluestring[]requiredtypestringrequiredmimeoperatorobjectrequiredShow propertiesHide properties
conditionstringrequiredeqvalueintegerrequiredconditionstringrequirednevalueintegerrequiredconditionstringrequiredltvalueintegerrequiredconditionstringrequiredltevalueintegerrequiredconditionstringrequiredgtvalueintegerrequiredconditionstringrequiredgtevalueintegerrequiredconditionstringrequiredinvalueinteger[]requiredtypestringrequireddurationtypestringrequiredvideotypestringrequiredThe kind of Asset that the slot takes. It never changes, and it equals params.type.
imagevideoupdatedAtnumber | nullrequiredWhen the Placement last changed. null until its first update.
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[]requiredOne entry for each field that does not match.
Show propertiesHide properties
objectinstringrequiredThe part of the request that holds the field.
bodycookieheadersparamsquerymessagestringrequiredA sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.
pathstringrequiredA JSON Pointer into that part of the request, such as /filename. An empty string is the whole part.
errorstringrequiredA stable code for the failure. This is the field to branch on. It does not change for a given failure.
invalid_requestmessagestringrequiredA sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.
No API key, or one that does not resolve. See the security scheme. error is unauthorized.
errorstringrequiredA stable code for the failure. This is the field to branch on. It does not change for a given failure.
unauthorizedmessagestringrequiredA sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.
The organization has no active subscription. An owner subscribes at paywallUrl. error is organization_unentitled.
paywallUrlstring<uri>requiredThe page where an owner of the organization subscribes. Show it to the person.
errorstringrequiredA stable code for the failure. This is the field to branch on. It does not change for a given failure.
organization_unentitledmessagestringrequiredA sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.
The caller does not hold library:write. error is forbidden.
errorstringrequiredA stable code for the failure. This is the field to branch on. It does not change for a given failure.
forbiddenmessagestringrequiredA sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.
No Placement group of your organization with that id. A global group answers this too, because only AdCrunch changes one. error is not_found. Or no live Placement with the placementId that your organization sees.
errorstringrequiredA stable code for the failure. This is the field to branch on. It does not change for a given failure.
messagestringrequiredA sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.