Update a contact field

PATCH

/api/v1/contact-attributes/{key}

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Patch,
    RequestUri = new Uri("https://dashboard.azimea.com/api/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://dashboard.azimea.com/api/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://dashboard.azimea.com/api/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

ApiKey

Parameters

Path Parameters

key

required

string

Request Body^required

application/json

object

label

string

nullable 0 <= 80 characters

Example

Subscription plan

description

string

nullable 0 <= 300 characters

Example

null

archived

boolean

nullable

Example

false

Example

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

Responses

200

The field as it is now

application/json

object

isSuccess

boolean

value

One of:

object

object

key

string

label

string

type

string

Allowed values: Text Number Boolean Date DateTime TextList

description

string

nullable

createdFrom

string

Allowed values: Ui Api Csv

createdAt

string format: date-time

archivedAt

string format: date-time

nullable

status

integer format: int32

errors

Array<object>

object

code

string

message

string

params

object

key

additional properties

fieldErrors

object

key

additional properties

Array<object>

object

code

string

message

string

params

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
}

400

Validation failed: see errors[].code and fieldErrors

application/problem+json

object

statusCode

integer format: int32

default: 400

message

string

default: One or more errors occurred!

errors

object

key

additional properties

Array<string>

Example

{
  "statusCode": 400,
  "message": "One or more errors occurred!"
}

401

Missing or invalid API key

403

The key lacks the contacts:write permission

Update a contact field

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Example

Example

Example

Example

Responses

200

Example

400

Example

401

403

Request Body^required