Assert a list entry by parent

curl --request PUT \
  --url https://api.attio.com/v2/lists/{list}/entries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "parent_record_id": "891dcbfc-9141-415d-9b2a-2238a6cc012d",
    "parent_object": "people",
    "entry_values": {
      "41252299-f8c7-4b5e-99c9-4ff8321d2f96": "Text value",
      "multiselect_attribute": [
        "Select option 1",
        "Select option 2"
      ]
    }
  }
}
'

{
  "data": {
    "id": {
      "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
      "list_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0",
      "entry_id": "2e6e29ea-c4e0-4f44-842d-78a891f8c156"
    },
    "parent_record_id": "891dcbfc-9141-415d-9b2a-2238a6cc012d",
    "parent_object": "people",
    "created_at": "2022-11-21T13:22:49.061281000Z",
    "entry_values": {
      "status": [
        {
          "active_from": "2023-01-01T15:00:00.000000000Z",
          "active_until": null,
          "created_by_actor": {
            "type": "workspace-member",
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
          },
          "status": {
            "id": {
              "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
              "object_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0",
              "attribute_id": "e350362f-4b55-4c0f-93f4-379ae8ff2e5b",
              "status_id": "527def35-7994-4ef7-9584-80ef8de352a8"
            },
            "title": "In Progress",
            "is_archived": false,
            "target_time_in_status": null,
            "celebration_enabled": false
          },
          "attribute_type": "status"
        }
      ],
      "created_at": [
        {
          "active_from": "2023-01-01T15:00:00.000000000Z",
          "active_until": null,
          "created_by_actor": {
            "type": "workspace-member",
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
          },
          "value": "2023-01-01T15:00:00.000000000Z",
          "attribute_type": "timestamp"
        }
      ],
      "created_by": [
        {
          "active_from": "2023-01-01T15:00:00.000000000Z",
          "active_until": null,
          "created_by_actor": {
            "type": "workspace-member",
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
          },
          "referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
          "referenced_actor_type": "workspace-member",
          "attribute_type": "actor-reference"
        }
      ]
    }
  }
}

Entries

Assert a list entry by parent

Use this endpoint to create or update a list entry for a given parent record. If an entry with the specified parent record is found, that entry will be updated. If no such entry is found, a new entry will be created instead. If there are multiple entries with the same parent record, this endpoint with return the “MULTIPLE_MATCH_RESULTS” error. When writing to multi-select attributes, all values will be either created or deleted as necessary to match the list of values supplied in the request body.

Required scopes: list_entry:read-write, list_configuration:read.

PUT

lists

{list}

entries

Assert a list entry by parent

curl --request PUT \
  --url https://api.attio.com/v2/lists/{list}/entries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "parent_record_id": "891dcbfc-9141-415d-9b2a-2238a6cc012d",
    "parent_object": "people",
    "entry_values": {
      "41252299-f8c7-4b5e-99c9-4ff8321d2f96": "Text value",
      "multiselect_attribute": [
        "Select option 1",
        "Select option 2"
      ]
    }
  }
}
'

{
  "data": {
    "id": {
      "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
      "list_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0",
      "entry_id": "2e6e29ea-c4e0-4f44-842d-78a891f8c156"
    },
    "parent_record_id": "891dcbfc-9141-415d-9b2a-2238a6cc012d",
    "parent_object": "people",
    "created_at": "2022-11-21T13:22:49.061281000Z",
    "entry_values": {
      "status": [
        {
          "active_from": "2023-01-01T15:00:00.000000000Z",
          "active_until": null,
          "created_by_actor": {
            "type": "workspace-member",
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
          },
          "status": {
            "id": {
              "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
              "object_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0",
              "attribute_id": "e350362f-4b55-4c0f-93f4-379ae8ff2e5b",
              "status_id": "527def35-7994-4ef7-9584-80ef8de352a8"
            },
            "title": "In Progress",
            "is_archived": false,
            "target_time_in_status": null,
            "celebration_enabled": false
          },
          "attribute_type": "status"
        }
      ],
      "created_at": [
        {
          "active_from": "2023-01-01T15:00:00.000000000Z",
          "active_until": null,
          "created_by_actor": {
            "type": "workspace-member",
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
          },
          "value": "2023-01-01T15:00:00.000000000Z",
          "attribute_type": "timestamp"
        }
      ],
      "created_by": [
        {
          "active_from": "2023-01-01T15:00:00.000000000Z",
          "active_until": null,
          "created_by_actor": {
            "type": "workspace-member",
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
          },
          "referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
          "referenced_actor_type": "workspace-member",
          "attribute_type": "actor-reference"
        }
      ]
    }
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

list

string

required

A UUID or slug of the list the list entry belongs to.

Example:

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

Body

application/json

data

object

required

Show child attributes

data.parent_record_id

string<uuid>

required

A UUID identifying the record you want to add to the list. The record will become the 'parent' of the created list entry.

Example:

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

data.parent_object

string

required

A UUID or slug identifying the object that the added parent record belongs to.

Example:

"people"

data.entry_values

object

required

An object with an attribute api_slug or attribute_id as the key, and a single value (for single-select attributes), or an array of values (for single or multi-select attributes) as the values. For complete documentation on values for all attribute types, please see our attribute type docs.

Show child attributes

data.entry_values.{key}

array

Example:

{
  "41252299-f8c7-4b5e-99c9-4ff8321d2f96": "Text value",
  "multiselect_attribute": ["Select option 1", "Select option 2"]
}

Response

Success

data

object

required

Show child attributes

data.id

object

required

Show child attributes

data.id.workspace_id

string<uuid>

required

A UUID identifying the workspace this entry belongs to.

Example:

"14beef7a-99f7-4534-a87e-70b564330a4c"

data.id.list_id

string<uuid>

required

A UUID identifying the list this entry is in.

Example:

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

data.id.entry_id

string<uuid>

required

A UUID identifying this entry.

Example:

"2e6e29ea-c4e0-4f44-842d-78a891f8c156"

data.parent_record_id

string<uuid>

required

A UUID identifying the record that is parent of the list entry.

Example:

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

data.parent_object

string

required

A UUID or slug identifying the object that the parent record belongs to.

Example:

"people"

data.created_at

string

required

When this entry was created.

Example:

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

data.entry_values

object

required

A list of attribute values for the list entry (not attribute values for its parent record).

Show child attributes

data.entry_values.{key}

object[]

Show child attributes

data.entry_values.{key}.active_from

string<date-time>

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.entry_values.{key}.active_until

string<date-time> | 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.entry_values.{key}.created_by_actor

object

required

The actor that created this value.

Show child attributes

data.entry_values.{key}.created_by_actor.id

string | null

An ID to identify the actor.

data.entry_values.{key}.created_by_actor.type

enum<string> | null

The type of actor. Read more information on actor types here.

Available options:

api-token,

workspace-member,

system,

app

Example:

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

data.entry_values.{key}.referenced_actor_type

enum<string>

required

The type of the referenced actor. Read more information on actor types here.

Available options:

api-token,

workspace-member,

system,

app

Example:

"workspace-member"

data.entry_values.{key}.referenced_actor_id

string<uuid> | null

required

The ID of the referenced actor.

Example:

"50cf242c-7fa3-4cad-87d0-75b1af71c57b"

data.entry_values.{key}.attribute_type

enum<string>

required

The attribute type of the value.

Available options:

actor-reference

Example:

"actor-reference"

Example:

{
  "status": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": {
        "type": "workspace-member",
        "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
      },
      "status": {
        "id": {
          "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
          "object_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0",
          "attribute_id": "e350362f-4b55-4c0f-93f4-379ae8ff2e5b",
          "status_id": "527def35-7994-4ef7-9584-80ef8de352a8"
        },
        "title": "In Progress",
        "is_archived": false,
        "target_time_in_status": null,
        "celebration_enabled": false
      },
      "attribute_type": "status"
    }
  ],
  "created_at": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": {
        "type": "workspace-member",
        "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
      },
      "value": "2023-01-01T15:00:00.000000000Z",
      "attribute_type": "timestamp"
    }
  ],
  "created_by": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": {
        "type": "workspace-member",
        "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
      },
      "referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
      "referenced_actor_type": "workspace-member",
      "attribute_type": "actor-reference"
    }
  ]
}

List entries Create an entry (add record to list)

⌘I

Introduction

Guides

Tutorials

Endpoint reference

Webhook reference

Assert a list entry by parent

Authorizations

Path Parameters

Body

Response