Users

Assert a user record

Use this endpoint to create or update user records, using a unique attribute to search for existing users (for example the primary_email_address attribute). If a user is found with the same value for the matching attribute, that user will be updated, otherwise a new user will be created instead. If the matching attribute is a multiselect attribute, new values will be added and existing values will not be deleted. For any other multiselect attribute, all values will be either created or deleted as necessary to match the list of supplied values.

Required scopes: record_permission:read-write, object_configuration:read.

PUT

objects

users

records

curl --request PUT \
  --url https://api.attio.com/v2/objects/users/records \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "data": {
    "values": {
      "user_id": "123",
      "primary_email_address": "person@company.com",
      "person": {
        "target_object": "people",
        "target_record_id": "891dcbfc-9141-415d-9b2a-2238a6cc012d"
      },
      "workspace": {
        "target_object": "workspaces",
        "target_record_id": "72ef5feaf-4919-4208-b332-1339ab8ba040"
      }
    }
  }
}'

{
  "data": {
    "id": {
      "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
      "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
      "record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b"
    },
    "created_at": "2022-11-21T13:22:49.061281000Z",
    "values": {
      "person": [
        {
          "active_from": "2023-01-01T15:00:00.000000000Z",
          "active_until": null,
          "created_by_actor": {
            "type": "system",
            "id": null
          },
          "target_object": "people",
          "target_record_id": "891dcbfc-9141-415d-9b2a-2238a6cc012d",
          "attribute_type": "record-reference"
        }
      ],
      "primary_email_address": [
        {
          "active_from": "2023-01-01T15:00:00.000000000Z",
          "active_until": null,
          "created_by_actor": {
            "type": "system",
            "id": null
          },
          "original_email_address": "person@company.com",
          "email_address": "person@company.com",
          "email_domain": "company.com",
          "email_root_domain": "company.com",
          "email_local_specifier": "person",
          "attribute_type": "email-address"
        }
      ],
      "user_id": [
        {
          "active_from": "2023-01-01T15:00:00.000000000Z",
          "active_until": null,
          "created_by_actor": {
            "type": "system",
            "id": null
          },
          "value": "123",
          "attribute_type": "text"
        }
      ],
      "workspace": [
        {
          "active_from": "2023-01-01T15:00:00.000000000Z",
          "active_until": null,
          "created_by_actor": {
            "type": "system",
            "id": null
          },
          "target_object": "workspaces",
          "target_record_id": "72ef5feaf-4919-4208-b332-1339ab8ba040",
          "attribute_type": "record-reference"
        }
      ]
    }
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

matching_attribute

string

required

The ID or slug of the attribute to use to check if a user already exists. The attribute must be unique. For user records, you can use primary_email_address or user_id, or any additional custom attribute with a unique constraint.

Example:

"primary_email_address"

Body

application/json

data

object

required

data.values

object

required

This object's keys should be the slugs or IDs of the attributes you wish to update. Below, you'll find documentation for the value types of each standard user attribute. For information on potential custom attributes, refer to our attribute type docs.

Example:

{
  "user_id": "123",
  "primary_email_address": "person@company.com",
  "person": {
    "target_object": "people",
    "target_record_id": "891dcbfc-9141-415d-9b2a-2238a6cc012d"
  },
  "workspace": {
    "target_object": "workspaces",
    "target_record_id": "72ef5feaf-4919-4208-b332-1339ab8ba040"
  }
}

Response

200

application/json

Success

data

object

required

data.id

object

required

data.created_at

string

required

When this record was created.

Example:

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

data.values

object

required

An object with attribute_slug keys, and an array of value objects as the values. Attributes slugs (for example person or primary_email_address) can be used, including custom attribute slugs.

data.values.person

object[]

data.values.person.active_from

string

required

The point in time at which this value was made "active". active_from can be considered roughly analogous to created_at.

Example:

"2023-01-01T15:00:00.000000000Z"

data.values.person.active_until

string | null

required

The point in time at which this value was deactivated. If null, the value is active.

Example:

"2023-01-01T15:00:00.000000000Z"

data.values.person.created_by_actor

object

required

The actor that created this value.

Example:

{
  "type": "workspace-member",
  "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
}

data.values.person.target_object

string

required

A slug identifying the object that the referenced record belongs to.

Example:

"people"

data.values.person.target_record_id

string

required

A UUID to identify the referenced record.

Example:

"891dcbfc-9141-415d-9b2a-2238a6cc012d"

data.values.person.attribute_type

enum<string>

required

The attribute type of the value.

Available options:

record-reference

Example:

"record-reference"

data.values.primary_email_address

object[]

data.values.primary_email_address.active_from

string

required

The point in time at which this value was made "active". active_from can be considered roughly analogous to created_at.

Example:

"2023-01-01T15:00:00.000000000Z"

data.values.primary_email_address.active_until

string | null

required

The point in time at which this value was deactivated. If null, the value is active.

Example:

"2023-01-01T15:00:00.000000000Z"

data.values.primary_email_address.created_by_actor

object

required

The actor that created this value.

Example:

{
  "type": "workspace-member",
  "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
}

data.values.primary_email_address.original_email_address

string

required

Example:

"alice@app.attio.com"

data.values.primary_email_address.email_address

string

required

Example:

"alice@app.attio.com"

data.values.primary_email_address.email_domain

string

required

Example:

"app.attio.com"

data.values.primary_email_address.email_root_domain

string

required

Example:

"attio.com"

data.values.primary_email_address.email_local_specifier

string

required

Example:

"alice"

data.values.primary_email_address.attribute_type

enum<string>

required

The attribute type of the value.

Available options:

email-address

Example:

"email-address"

data.values.user_id

object[]

data.values.user_id.active_from

string

required

The point in time at which this value was made "active". active_from can be considered roughly analogous to created_at.

Example:

"2023-01-01T15:00:00.000000000Z"

data.values.user_id.active_until

string | null

required

The point in time at which this value was deactivated. If null, the value is active.

Example:

"2023-01-01T15:00:00.000000000Z"

data.values.user_id.created_by_actor

object

required

The actor that created this value.

Example:

{
  "type": "workspace-member",
  "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
}

data.values.user_id.value

string

required

A raw text field. Values are limited to 10MB.

Example:

"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."

data.values.user_id.attribute_type

enum<string>

required

The attribute type of the value.

Available options:

text

Example:

"text"

data.values.workspace

object[]

data.values.workspace.active_from

string

required

The point in time at which this value was made "active". active_from can be considered roughly analogous to created_at.

Example:

"2023-01-01T15:00:00.000000000Z"

data.values.workspace.active_until

string | null

required

The point in time at which this value was deactivated. If null, the value is active.

Example:

"2023-01-01T15:00:00.000000000Z"

data.values.workspace.created_by_actor

object

required

The actor that created this value.

Example:

{
  "type": "workspace-member",
  "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
}

data.values.workspace.target_object

string

required

A slug identifying the object that the referenced record belongs to.

Example:

"people"

data.values.workspace.target_record_id

string

required

A UUID to identify the referenced record.

Example:

"891dcbfc-9141-415d-9b2a-2238a6cc012d"

data.values.workspace.attribute_type

enum<string>

required

The attribute type of the value.

Available options:

record-reference

Example:

"record-reference"

Example:

{
  "person": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "target_object": "people",
      "target_record_id": "891dcbfc-9141-415d-9b2a-2238a6cc012d",
      "attribute_type": "record-reference"
    }
  ],
  "primary_email_address": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "original_email_address": "person@company.com",
      "email_address": "person@company.com",
      "email_domain": "company.com",
      "email_root_domain": "company.com",
      "email_local_specifier": "person",
      "attribute_type": "email-address"
    }
  ],
  "user_id": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "value": "123",
      "attribute_type": "text"
    }
  ],
  "workspace": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "target_object": "workspaces",
      "target_record_id": "72ef5feaf-4919-4208-b332-1339ab8ba040",
      "attribute_type": "record-reference"
    }
  ]
}

List user records Create a user record

curl --request PUT \
  --url https://api.attio.com/v2/objects/users/records \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "data": {
    "values": {
      "user_id": "123",
      "primary_email_address": "person@company.com",
      "person": {
        "target_object": "people",
        "target_record_id": "891dcbfc-9141-415d-9b2a-2238a6cc012d"
      },
      "workspace": {
        "target_object": "workspaces",
        "target_record_id": "72ef5feaf-4919-4208-b332-1339ab8ba040"
      }
    }
  }
}'

{
  "data": {
    "id": {
      "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
      "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
      "record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b"
    },
    "created_at": "2022-11-21T13:22:49.061281000Z",
    "values": {
      "person": [
        {
          "active_from": "2023-01-01T15:00:00.000000000Z",
          "active_until": null,
          "created_by_actor": {
            "type": "system",
            "id": null
          },
          "target_object": "people",
          "target_record_id": "891dcbfc-9141-415d-9b2a-2238a6cc012d",
          "attribute_type": "record-reference"
        }
      ],
      "primary_email_address": [
        {
          "active_from": "2023-01-01T15:00:00.000000000Z",
          "active_until": null,
          "created_by_actor": {
            "type": "system",
            "id": null
          },
          "original_email_address": "person@company.com",
          "email_address": "person@company.com",
          "email_domain": "company.com",
          "email_root_domain": "company.com",
          "email_local_specifier": "person",
          "attribute_type": "email-address"
        }
      ],
      "user_id": [
        {
          "active_from": "2023-01-01T15:00:00.000000000Z",
          "active_until": null,
          "created_by_actor": {
            "type": "system",
            "id": null
          },
          "value": "123",
          "attribute_type": "text"
        }
      ],
      "workspace": [
        {
          "active_from": "2023-01-01T15:00:00.000000000Z",
          "active_until": null,
          "created_by_actor": {
            "type": "system",
            "id": null
          },
          "target_object": "workspaces",
          "target_record_id": "72ef5feaf-4919-4208-b332-1339ab8ba040",
          "attribute_type": "record-reference"
        }
      ]
    }
  }
}

People

Companies

Users

Deals

Workspaces

Assert a user record

Authorizations

Query Parameters

Body

Response