Docs
kirora.ioGet started
Attributes overviewMenu
On this page

API reference

Attributes

Attributes are the custom fields your contacts carry, such as plan or orders, discovered from the values you send. These operations list the keys and their values for rule builders and merge tags; you set attributes on the contact itself, through identify or updateContact.

Endpoints

EndpointRequest
List contact attribute keysGET /v1/attributes
List the values of an attributeGET /v1/attributes/{key}/values
Describe an attribute keyPUT /v1/attributes/{key}

The Attribute object

Attribute example
{
  "key": "key_example",
  "type": "string",
  "contactCount": 0,
  "masked": true,
  "description": "description_example"
}
keystringrequired

The attribute key, as written on contacts.

typestringrequired

Inferred from the values held. list: every value is an array (["running", "yoga"], a form's checkboxes); mixed: more than one type.

one of string, number, boolean, date, list, mixed

contactCountintegerrequired

Contacts that have this key.

min 0

maskedbooleanrequired

Masked in workspace settings: members see the key, not its values.

descriptionstring | nullrequired

What the key means, as an admin described it; null when none.