Update a contact field
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Patch, RequestUri = new Uri("https://api.azimea.com/v1/contact-attributes/example"), Headers = { { "Authorization", "Bearer <token>" }, }, Content = new StringContent("{ \"label\": \"Subscription plan\", \"description\": null, \"archived\": false }") { Headers = { ContentType = new MediaTypeHeaderValue("application/json") } }};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}const url = 'https://api.azimea.com/v1/contact-attributes/example';const options = { method: 'PATCH', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"label":"Subscription plan","description":null,"archived":false}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Request Bodyrequired
Section titled “Request Bodyrequired”object
A new display name. Left out, the current one stays.
Example
Subscription planA new note for your team. Left out, the current one stays.
Example
nulltrue hides the field from pickers and keeps every stored value; false brings it back. Left out, nothing changes.
Example
falseExample
{ "label": "Subscription plan", "description": null, "archived": false}Responses
Section titled “Responses”The field as it is now
object
true when the call worked, false when errors say why it did not.
The answer itself; null when the call failed.
object
The field’s key: lowercase letters, digits and _, starting with a letter, at most 40 characters. It never changes.
The name shown in the dashboard.
How values are stored and compared in segments. Fixed once the field exists.
A note for your team about what the field holds; null when none was written.
Where the field was made: the dashboard (Ui), the API (Api) or a file import (Csv).
When the field was created.
When the field was archived; null while it is active. An archived field is hidden from pickers and keeps every stored value.
An internal result number. Rely on the HTTP status code instead.
What went wrong, one entry per problem; empty when the call worked.
object
A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.
An English sentence for your logs. Do not show it to end users: it can change.
The numbers the message mentions (a minimum, a maximum), when there are any.
object
The same problems grouped by the request field they belong to; null when none is tied to a field.
object
object
A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.
An English sentence for your logs. Do not show it to end users: it can change.
The numbers the message mentions (a minimum, a maximum), when there are any.
object
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
object
true when the call worked, false when errors say why it did not.
The answer itself; null when the call failed.
An internal result number. Rely on the HTTP status code instead.
What went wrong, one entry per problem; empty when the call worked.
object
A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.
An English sentence for your logs. Do not show it to end users: it can change.
The numbers the message mentions (a minimum, a maximum), when there are any.
object
The same problems grouped by the request field they belong to; null when none is tied to a field.
object
object
A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.
An English sentence for your logs. Do not show it to end users: it can change.
The numbers the message mentions (a minimum, a maximum), when there are any.
object
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
object
true when the call worked, false when errors say why it did not.
The answer itself; null when the call failed.
An internal result number. Rely on the HTTP status code instead.
What went wrong, one entry per problem; empty when the call worked.
object
A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.
An English sentence for your logs. Do not show it to end users: it can change.
The numbers the message mentions (a minimum, a maximum), when there are any.
object
The same problems grouped by the request field they belong to; null when none is tied to a field.
object
object
A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.
An English sentence for your logs. Do not show it to end users: it can change.
The numbers the message mentions (a minimum, a maximum), when there are any.
object
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