Lists

Update a list

Updates an existing list. Permissions for the list are controlled with the workspace_access and workspace_member_access parameters. Please note that lists must have either workspace_access set to "full-access" or one or more element of workspace_member_access with a "full-access" level. It is also possible to receive a 403 billing error if your workspace is not on a plan that supports either advanced workspace or workspace member level access for lists. Changing the parent object of a list is not possible through the API as it can have unintended side-effects that should be considered carefully. If you wish to carry out a parent object change you should do so through the UI.

Required scopes: list_configuration:read-write.

PATCH

lists

{list}

curl --request PATCH \
  --url https://api.attio.com/v2/lists/{list} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "data": {
    "name": "Enterprise Sales",
    "api_slug": "enterprise_sales",
    "workspace_access": "read-and-write",
    "workspace_member_access": [
      {
        "workspace_member_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
        "level": "read-and-write"
      }
    ]
  }
}'

{
  "data": {
    "id": {
      "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
      "list_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0"
    },
    "api_slug": "hiring-engineering",
    "name": "Hiring Engineering",
    "parent_object": [
      "people"
    ],
    "workspace_access": "read-and-write",
    "workspace_member_access": [
      {
        "workspace_member_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
        "level": "read-and-write"
      }
    ],
    "created_by_actor": {
      "type": "workspace-member",
      "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
    },
    "created_at": "2022-11-21T13:22:49.061281000Z"
  }
}

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 to identify the list to update.

Example:

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

Body

application/json

data

object

required

Response

200

application/json

Success

data

object

required

data.id

object

required

data.api_slug

string

required

A human-readable slug for use in URLs and responses.

Example:

"hiring-engineering"

data.name

string

required

The name of the list, as viewed in the UI.

Example:

"Hiring Engineering"

data.parent_object

string[]

required

A UUID or slug to identify the allowed object type for records added to this list. All new Lists are expected to have exactly one parent object. However, some legacy lists may have multiple allowed parents so the return type of this field is an array.

Example:

["people"]

data.workspace_access

enum<string> | null

required

The level of access granted to all members of the workspace for this list. null values represent a private list that only grants access to specific workspace members via the workspace_member_access property.

Available options:

full-access,

read-and-write,

read-only

Example:

"read-and-write"

data.workspace_member_access

object[]

required

The level of access granted to specific workspace members for this list. An empty array represents a list that has granted access to no workspace members.

data.created_by_actor

object

required

The actor which created this list.

Example:

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

data.created_at

string

required

When the list was created.

Example:

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

Get a list List entries

curl --request PATCH \
  --url https://api.attio.com/v2/lists/{list} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "data": {
    "name": "Enterprise Sales",
    "api_slug": "enterprise_sales",
    "workspace_access": "read-and-write",
    "workspace_member_access": [
      {
        "workspace_member_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
        "level": "read-and-write"
      }
    ]
  }
}'

{
  "data": {
    "id": {
      "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
      "list_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0"
    },
    "api_slug": "hiring-engineering",
    "name": "Hiring Engineering",
    "parent_object": [
      "people"
    ],
    "workspace_access": "read-and-write",
    "workspace_member_access": [
      {
        "workspace_member_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
        "level": "read-and-write"
      }
    ],
    "created_by_actor": {
      "type": "workspace-member",
      "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
    },
    "created_at": "2022-11-21T13:22:49.061281000Z"
  }
}

Objects

Attributes

Records

Lists

Entries

Workspace members

Notes

Tasks

Threads

Comments

Webhooks

Meta

Update a list

Authorizations

Path Parameters

Body

Response