Create a Placement group
Creates a Placement group of your organization: a named set of Placements. A group has no channel, and it holds Placements of any channel that your organization sees. The new group holds no Placement: add each one with POST /library/placement-groups/{groupId}/placements.
The name must be unique, ignoring case, among the groups that your organization sees. An organization holds 50 live groups at most.
/library/placement-groupsAuthorizationBearer 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.
application/jsondescriptionstring | nullA free text, up to 1000 characters. AdCrunch trims it. An empty string is stored as no description.
namestringrequiredThe name, 1 to 80 characters. AdCrunch trims it. It must be unique, ignoring case, among the ones that your organization sees.
The new group, with isGlobal false.
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.
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.
The group cannot be created now. name_taken: a live group that your organization sees holds this name, ignoring case. placement_group_limit: your organization holds 50 live groups.
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.