library_placement_group_update
Change the name or the description of a Placement group of your organization.
Ask to rename a group. The agent changes the name or the description. A field that the call leaves out stays as it is.
“Rename the Stories group to Vertical.”
To change the Placements of the group, the agent uses library_placement_group_add and library_placement_group_remove. A global group is read-only.
This tool is part of the job Bring your own creative.
Reference
Change the name or the description of a Placement group of your organization. A field that the call leaves out stays as it is. To change the Placements of the group, use library_placement_group_add and library_placement_group_remove. A Placement group is a named set of Placements, for example all the Placements of one channel. A group has no channel and no rules. A group of your organization holds global Placements and Placements of your organization. A global group holds global Placements only. A global row (isGlobal is true) is held by AdCrunch for each organization. You read it and use it. A change of a global row, and a delete of it, answer not_found.
Input
| Argument | Type | Required | Description |
|---|---|---|---|
description |
string or null | no | A free text. A blank text or null stores no description. On an update, leave it out to keep the description. |
group_id |
string | yes | The id of a Placement group (plg_…). library_placement_group_list gives it. |
name |
string | no | The name, 1 to 80 characters. AdCrunch trims it. It must be unique, ignoring case, among the ones that your organization sees: for a Placement, among the Placements of the same channel. |
Output
A successful call returns this object in structuredContent.
| Field | Type | Always present | Description |
|---|---|---|---|
group |
object | yes | The group with its new name or description, and no Placement. library_placement_group_get reads its Placements. |
group.createdAt |
number | yes | Milliseconds since the Unix epoch, UTC. |
group.createdBy |
string or null | yes | The user who created the group. null on a global row. |
group.deletedAt |
number or null | yes | Always null here. A deleted group is not answered. |
group.description |
string or null | yes | A free text. null when the group has none. |
group.id |
string | yes | The id of the group, plg_…. |
group.isGlobal |
boolean | yes | true on a row that AdCrunch holds for every organization. You read it, and you cannot change or delete it. |
group.name |
string | yes | The name, 1 to 80 characters. It is unique, ignoring case, among the groups that the organization sees. |
group.organizationId |
string or null | yes | The organization that owns the group. null on a global row. |
group.updatedAt |
number or null | yes | When the group last changed. null until its first update. |
Failure codes
A failed call has isError set, and structuredContent.error holds one of these codes. Errors describes the shape of a failed call.
not_foundinvalid_namename_takenorganization_unentitledforbiddeninvalid_requestinternal_error
Scope
The token must hold library:write. Auth & scopes lists each scope.
Annotations
A client reads these hints. A hint that the tool does not declare has the default value of the MCP specification.
- Writes. The tool can change data.
- Not destructive. The tool makes only additive changes.
- Idempotent. A second call with the same arguments changes nothing more.
- Closed world. The tool reads and writes the data of AdCrunch only.
Example
The arguments:
{
"group_id": "plg_9e1c53",
"name": "Vertical video"
}
The result, in structuredContent:
{
"group": {
"createdAt": 1790000600000,
"createdBy": "usr_2e5b84",
"deletedAt": null,
"description": null,
"id": "plg_9e1c53",
"isGlobal": false,
"name": "Vertical video",
"organizationId": "org_3a7f10",
"updatedAt": 1790000900000
}
}