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

Rename a Creative

Renames a Creative. The name is the only field of a Creative that changes. A Variation has no update: to use another Asset, remove the Variation and add a new one.

PATCH/library/creatives/{creativeId}
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
creativeIdstringrequired

The Creative id.

matches ^(crv_)[\s\S]{0,}$
Request body
requiredapplication/json
namestring | nullrequired

The new name. AdCrunch trims it. Send null or an empty string to remove the name.

max length 255
Responses
200

The Creative, with its new name and the count of its Variations.

createdAtnumberrequired

Milliseconds since the Unix epoch, UTC.

createdBystringrequired

The user who created the Creative.

deletedAtnumber | nullrequired

Always null here. A deleted Creative is not answered.

idstringrequired

The id of the Creative, crv_….

namestring | nullrequired

The name a person gave the Creative. null when nobody named it. There is no fallback name.

organizationIdstringrequired

The organization that owns the Creative.

updatedAtnumber | nullrequired

When the Creative last changed, in milliseconds since the Unix epoch, UTC. null until its first rename.

variationCountnumberrequired

How many Variations the Creative holds. Read them with the list of the Variations of the Creative.

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 creative: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 Creative with that id in this organization. A deleted Creative answers this too. 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.

Request
curl -X PATCH 'https://api.pr-1314.adcrunch.dev/library/creatives/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Spring sale, final cut"
}'
Response
{
  "createdAt": 1790000300000,
  "createdBy": "usr_2e5b84",
  "deletedAt": null,
  "id": "crv_5e2a19",
  "name": "Spring sale, final cut",
  "organizationId": "org_3a7f10",
  "updatedAt": 1790000420000,
  "variationCount": 2
}

Was this page helpful?