Skip to content
AzimeaDocs
Dashboard
PATCH
/contact-attributes/{key}
curl --request PATCH \
--url https://api.azimea.com/v1/contact-attributes/example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "label": "Subscription plan", "description": null, "archived": false }'

Renames or describes a custom attribute, or archives it (archived: true hides it from pickers and keeps every stored value; false brings it back). Its key and type never change: rules and stored values rely on them. Needs contacts:write.

key
required
string
Media typeapplication/json
object
label

A new display name. Left out, the current one stays.

string
nullable 0 <= 80 characters
Example
Subscription plan
description

A new note for your team. Left out, the current one stays.

string
nullable 0 <= 300 characters
Example
null
archived

true hides the field from pickers and keeps every stored value; false brings it back. Left out, nothing changes.

boolean
nullable
Example
false
Example
{
"label": "Subscription plan",
"description": null,
"archived": false
}

The field as it is now

Media typeapplication/json
object
isSuccess

true when the call worked, false when errors say why it did not.

boolean
value

The answer itself; null when the call failed.

object
key

The field’s key: lowercase letters, digits and _, starting with a letter, at most 40 characters. It never changes.

string
label

The name shown in the dashboard.

string
type

How values are stored and compared in segments. Fixed once the field exists.

string
Allowed values: Text Number Boolean Date DateTime TextList
description

A note for your team about what the field holds; null when none was written.

string
nullable
createdFrom

Where the field was made: the dashboard (Ui), the API (Api) or a file import (Csv).

string
Allowed values: Ui Api Csv
createdAt

When the field was created.

string format: date-time
archivedAt

When the field was archived; null while it is active. An archived field is hidden from pickers and keeps every stored value.

string format: date-time
nullable
status

An internal result number. Rely on the HTTP status code instead.

integer format: int32
errors

What went wrong, one entry per problem; empty when the call worked.

Array<object>
object
code

A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.

string
message

An English sentence for your logs. Do not show it to end users: it can change.

string
params

The numbers the message mentions (a minimum, a maximum), when there are any.

object
key
additional properties
fieldErrors

The same problems grouped by the request field they belong to; null when none is tied to a field.

object
key
additional properties
Array<object>
object
code

A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.

string
message

An English sentence for your logs. Do not show it to end users: it can change.

string
params

The numbers the message mentions (a minimum, a maximum), when there are any.

object
key
additional properties
Example
{
"isSuccess": true,
"value": {
"key": "plan",
"label": "Subscription plan",
"type": "Text",
"description": "The subscription plan the person is on.",
"createdFrom": "Api",
"createdAt": "2026-10-05T09:30:00+00:00",
"archivedAt": null
},
"status": 0,
"errors": [],
"fieldErrors": null
}

Validation failed: see errors[].code and fieldErrors

Media typeapplication/json
object
isSuccess

true when the call worked, false when errors say why it did not.

boolean
value

The answer itself; null when the call failed.

nullable
status

An internal result number. Rely on the HTTP status code instead.

integer format: int32
errors

What went wrong, one entry per problem; empty when the call worked.

Array<object>
object
code

A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.

string
message

An English sentence for your logs. Do not show it to end users: it can change.

string
params

The numbers the message mentions (a minimum, a maximum), when there are any.

object
key
additional properties
fieldErrors

The same problems grouped by the request field they belong to; null when none is tied to a field.

object
key
additional properties
Array<object>
object
code

A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.

string
message

An English sentence for your logs. Do not show it to end users: it can change.

string
params

The numbers the message mentions (a minimum, a maximum), when there are any.

object
key
additional properties
Example
{
"isSuccess": false,
"value": null,
"status": 5,
"errors": [
{
"code": "validation.required",
"message": "Fill in this field.",
"params": null
}
],
"fieldErrors": {
"email": [
{
"code": "validation.required",
"message": "Fill in this field.",
"params": null
}
]
}
}

Missing or invalid API key

The key lacks the contacts:write permission

Audience.attribute_not_found: no field has this key

Media typeapplication/json
object
isSuccess

true when the call worked, false when errors say why it did not.

boolean
value

The answer itself; null when the call failed.

nullable
status

An internal result number. Rely on the HTTP status code instead.

integer format: int32
errors

What went wrong, one entry per problem; empty when the call worked.

Array<object>
object
code

A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.

string
message

An English sentence for your logs. Do not show it to end users: it can change.

string
params

The numbers the message mentions (a minimum, a maximum), when there are any.

object
key
additional properties
fieldErrors

The same problems grouped by the request field they belong to; null when none is tied to a field.

object
key
additional properties
Array<object>
object
code

A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.

string
message

An English sentence for your logs. Do not show it to end users: it can change.

string
params

The numbers the message mentions (a minimum, a maximum), when there are any.

object
key
additional properties
Examplegenerated
{
"isSuccess": true,
"value": "example",
"status": 1,
"errors": [
{
"code": "example",
"message": "example",
"params": {
"additionalProperty": "example"
}
}
],
"fieldErrors": {
"additionalProperty": [
{
"code": "example",
"message": "example",
"params": {
"additionalProperty": "example"
}
}
]
}
}

Too many requests for this key