Skip to content
AdCrunch
Esc
navigateopen⌘Jpreview

Update a Persona

Updates a Persona. Send the base_revision you read. Omit a section or an age bound to keep it. Send null to clear it. AdCrunch checks the age range on the result of the merge. Therefore a call that sends only age_min can still fail, if the result is inverted. The answer is 409 with error=revision_mismatch if the Persona changed after you read it. It is 409 with error=slug_conflict if the new name gives a slug that already exists.

PATCH/context/brands/{slug}/personas/{personaSlug}
Authorization
AuthorizationBearer token · headerrequired

Send Authorization: Bearer <credential>. Two credentials work.

An API key (acr_…) is what a server integration uses. Create one in the AdCrunch console under Settings → API keys — see https://docs.adcrunch.dev/account/api-keys. A key is bound to the organization that was active when you created it, and it keeps acting on that organization whatever you do later. It carries the permissions of the member who created it.

A session issued by the AdCrunch sign-in flow also works, which is how the console calls this service from the browser.

Either way the organization comes from the credential. There is no organization parameter.

Path parameters
personaSlugstringrequired
slugstringrequired
Request body
requiredapplication/json
age_maxinteger | null

Upper age bound; null clears it ("and older").

min 0 · max 120
age_mininteger | null

Lower age bound; null clears it ("and younger").

min 0 · max 120
base_revisionintegerrequired

The revision last read via GET — guards concurrent edits.

min -9007199254740991 · max 9007199254740991
descriptionstring
min length 1 · max length 500
frictionsstring | null

Objections and barriers; null clears it.

min length 1
languagestring | null

The audience's own words — not a locale; null clears it.

min length 1
motivationsstring | null

Jobs, triggers, outcomes; null clears it.

min length 1
namestring
min length 1 · max length 120
profilestring | null

Who they are; null clears it.

min length 1
slugstring

Optional new slug handle (a deliberate rename).

max length 120
Responses
200

The Persona as it now stands.

ageMaxnumber | nullrequired
ageMinnumber | nullrequired

Each bound is independently optional, so "35+" is expressible.

brandIdstringrequired
createdAtnumberrequired

Milliseconds since the Unix epoch, UTC.

createdBystringrequired
descriptionstringrequired
frictionsstring | nullrequired

Objections, doubts, what stops them.

idstringrequired
languagestring | nullrequired

The words they use for the problem, in their own register. Not a locale, despite the name.

motivationsstring | nullrequired

What they want, and what triggers them.

namestringrequired
profilestring | nullrequired

Who they are, and their situation.

revisionnumberrequired

Increments on every write. Send it back as base_revision to edit; a stale one answers 409.

slugstringrequired
updatedAtnumber | nullrequired

Milliseconds since the Unix epoch, UTC.

401

No credential, or one that does not resolve. Send an API key or a session. 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.

403

The caller does not hold brand: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 such Brand, or no Persona with that slug inside it. 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

error tells the two conflicts apart: revision_mismatch and slug_conflict.

Any of:
object
currentRevisionnumberrequired

The revision the row holds now. Re-read, re-apply your edit on top, and send this back as base_revision.

errorstringrequired

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

Allowed:revision_mismatch
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
slugstringrequired

The slug that is already taken.

errorstringrequired

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

Allowed:slug_conflict
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.

422

invalid_slug, or invalid_age_range. The age range is checked against the merged result, so sending only age_min can still be rejected as inverted.

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.adcrunch.dev/context/brands/string/personas/string" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "age_max": 0,
  "age_min": 0,
  "base_revision": -9007199254740991,
  "description": "string",
  "frictions": "string",
  "language": "string",
  "motivations": "string",
  "name": "string",
  "profile": "string",
  "slug": "string"
}'
Response
{
  "ageMax": 0,
  "ageMin": 0,
  "brandId": "string",
  "createdAt": 0,
  "createdBy": "string",
  "description": "string",
  "frictions": "string",
  "id": "string",
  "language": "string",
  "motivations": "string",
  "name": "string",
  "profile": "string",
  "revision": 0,
  "slug": "string",
  "updatedAt": 0
}