Update an attribute

PATCH

{target}

{identifier}

attributes

{attribute}

curl --request PATCH \
  --url https://api.attio.com/v2/{target}/{identifier}/attributes/{attribute} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "data": {
    "title": "Your Attribute",
    "description": "Lorem ipsum",
    "api_slug": "my-attribute",
    "is_required": true,
    "is_unique": true,
    "default_value": {
      "type": "static",
      "template": [
        {
          "value": 5
        }
      ]
    },
    "config": {
      "currency": {
        "default_currency_code": "USD",
        "display_type": "symbol"
      },
      "record_reference": {
        "allowed_objects": [
          "people"
        ]
      }
    },
    "is_archived": false
  }
}'

{
  "data": {
    "id": {
      "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
      "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
      "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96"
    },
    "title": "Rating",
    "description": "Rating of the record out of 5",
    "api_slug": "Rating",
    "type": "rating",
    "is_system_attribute": false,
    "is_writable": true,
    "is_required": false,
    "is_unique": false,
    "is_multiselect": false,
    "is_default_value_enabled": false,
    "is_archived": false,
    "default_value": null,
    "relationship": null,
    "created_at": "2021-11-21T13:22:49.061Z",
    "config": {
      "currency": {
        "default_currency_code": null,
        "display_type": null
      },
      "record_reference": {
        "allowed_object_ids": null
      }
    }
  }
}

Authorizations

Authorization

string

header

required

This API uses OAuth 2.0 with the authorization code grant flow.

Path Parameters

target

enum<string>

required

Whether the attribute is on an object or a list.

Available options:

objects,

lists

Example:

"lists"

identifier

string

required

A UUID or slug to identify the object or list the attribute belongs to.

Example:

"33ebdbe9-e529-47c9-b894-0ba25e9c15c0"

attribute

string

required

A UUID or slug to identify the attribute.

Example:

"41252299-f8c7-4b5e-99c9-4ff8321d2f96"

Body

application/json

data

object

required

data.title

string

The name of the attribute. The title will be visible across Attio's UI.

Example:

"Your Attribute"

data.description

string | null

A text description for the attribute.

Example:

"Lorem ipsum"

data.api_slug

string

A unique, human-readable slug to access the attribute through URLs and API calls. Formatted in snake case.

Example:

"my-attribute"

data.is_required

boolean

When is_required is true, new records/entries must have a value for this attribute. If false, values may be null. This value does not affect existing data and you do not need to backfill null values if changing is_required from false to true.

Example:

true

data.is_unique

boolean

Whether or not new values for this attribute must be unique. Uniqueness restrictions are only applied to new data and do not apply retroactively to previously created data.

Example:

true

data.default_value

object | null

The default value for this attribute. Static values are used to directly populate values using their contents. Dynamic values are used to lookup data at the point of creation. For example, you could use a dynamic value to insert a value for the currently logged in user. Which default values are available is dependent on the type of the attribute. Default values are not currently supported on people or company objects.

Example:

{
  "type": "static",
  "template": [{ "value": 5 }]
}

data.config

object

Additional, type-dependent configuration for the attribute.

data.is_archived

boolean

Whether the attribute has been archived or not. See our archiving guide for more information on archiving.

Example:

false

Response

200

application/json

Success

data

object

required

data.id

object

required

data.title

string

required

A title for the attribute, to be displayed across the app.

Example:

"Rating"

data.description

string | null

required

A text description of the attribute.

Example:

"A rating attribute"

data.api_slug

string

required

A unique slug for the attribute for use in API responses and URLs. Formatted in snake case.

Example:

"my-rating"

data.type

enum<string>

required

The type of the attribute.

Available options:

text,

number,

checkbox,

currency,

date,

timestamp,

rating,

status,

select,

record-reference,

actor-reference,

location,

domain,

email-address,

phone-number,

interaction,

personal-name

Example:

"text"

data.is_system_attribute

boolean

required

true if this is an Attio system-defined attribute, false if defined by a user or non-Attio system.

Example:

true

data.is_writable

boolean

required

Whether or not this attribute can be written to. Can only be false when is_system_attribute is true (user-defined attributes are always writeable). If false, this usually means the attribute is enriched by Attio.

Example:

true

data.is_required

boolean

required

Example:

true

data.is_unique

boolean

required

Whether or not new values for this attribute must be unique. Uniqueness restrictions are only applied to new data and do not apply retroactively to previously created data.

Example:

true

data.is_multiselect

boolean

required

Whether or not this attribute can have multiple values. Multiselect is only available on some value types.

Example:

true

data.is_default_value_enabled

boolean

required

Whether this attribute has a default value enabled. Must be true when is_required is true.

Example:

true

data.is_archived

boolean

required

Whether this attribute has been archived. Archived attributes are hidden from most UI, but can be restored either over the API or in workspace settings. See the guide on archiving and deletingfor more information.

Example:

false

data.default_value

object | null

required

data.relationship

object | null

required

If this attribute is related to another attribute, this is an object that includes an id property that identifies the other attribute. null means no relationship exists. See the help center for more details about relationship attributes.

data.created_at

string

required

When this attribute was created.

Example:

"2022-11-21T13:22:49.061281000Z"

data.config

object

required

Additional, type-dependent configuration for the attribute.

Example:

{
  "id": {
    "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
    "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
    "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96"
  },
  "title": "Rating",
  "description": "Rating of the record out of 5",
  "api_slug": "Rating",
  "type": "rating",
  "is_system_attribute": false,
  "is_writable": true,
  "is_required": false,
  "is_unique": false,
  "is_multiselect": false,
  "is_default_value_enabled": false,
  "is_archived": false,
  "default_value": null,
  "relationship": null,
  "created_at": "2021-11-21T13:22:49.061Z",
  "config": {
    "currency": {
      "default_currency_code": null,
      "display_type": null
    },
    "record_reference": { "allowed_object_ids": null }
  }
}

Was this page helpful?

Get an attribute List select options

curl --request PATCH \
  --url https://api.attio.com/v2/{target}/{identifier}/attributes/{attribute} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "data": {
    "title": "Your Attribute",
    "description": "Lorem ipsum",
    "api_slug": "my-attribute",
    "is_required": true,
    "is_unique": true,
    "default_value": {
      "type": "static",
      "template": [
        {
          "value": 5
        }
      ]
    },
    "config": {
      "currency": {
        "default_currency_code": "USD",
        "display_type": "symbol"
      },
      "record_reference": {
        "allowed_objects": [
          "people"
        ]
      }
    },
    "is_archived": false
  }
}'

{
  "data": {
    "id": {
      "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
      "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
      "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96"
    },
    "title": "Rating",
    "description": "Rating of the record out of 5",
    "api_slug": "Rating",
    "type": "rating",
    "is_system_attribute": false,
    "is_writable": true,
    "is_required": false,
    "is_unique": false,
    "is_multiselect": false,
    "is_default_value_enabled": false,
    "is_archived": false,
    "default_value": null,
    "relationship": null,
    "created_at": "2021-11-21T13:22:49.061Z",
    "config": {
      "currency": {
        "default_currency_code": null,
        "display_type": null
      },
      "record_reference": {
        "allowed_object_ids": null
      }
    }
  }
}

Introduction

Tutorials

How-to guides

Endpoint reference

Authorizations

Path Parameters

Body

Response