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 /v2/objects/users/records

Assert a user record

cURL

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": "[e-mail]",
      "person": {
        "target_object": "people",
        "target_record_id": "891dcbfc-9141-415d-9b2a-2238a6cc012d"
      },
      "workspace": [
        {
          "target_object": "workspaces",
          "target_record_id": "72ef5feaf-4919-4208-b332-1339ab8ba040"
        }
      ]
    }
  }
}
'

200

{
  "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",
    "web_url": "https://app.attio.com/salarya/person/bf071e1f-6035-429d-b874-d83ea64ea13b",
    "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": "[e-mail]",
          "email_address": "[e-mail]",
          "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

Show child attributes

Response

200

application/json

Success

Success

data · object · required

Show child attributes