v1

latestOpenAPI 3.1.02026-07-14402976.1 KB

Users

Update a user Record

Use this endpoint to update user records by record_id. If the update payload includes multiselect attributes, the values supplied will be created and prepended to the list of values that already exist (if any). Use the Assert user endpoint to overwrite or remove multiselect attribute values. Please note, the avatar_url attribute cannot currently be updated via the API.

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

patch/v2/objects/users/records/{record_id}

Path parameters

record_idstring required

A UUID of the user record to update.

Example:5e3fb280-007b-495a-a530-9354bde01de1

Request body

Example request

{
  "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"
      }
    }
  }
}

Response

Success

Example response

{
  "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": "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"
        }
      ]
    }
  }
}