Workspaces

Assert a workspace record

Use this endpoint to create or update workspace records, using a unique attribute to search for existing workspaces (for example the workspace_id attribute). If a workspace is found with the same value for the matching attribute, that workspace will be updated, otherwise a new workspace 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

workspaces

records

curl --request PUT \
  --url https://api.attio.com/v2/objects/workspaces/records \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "data": {
    "values": {
      "workspace_id": "123",
      "name": "Customer.com",
      "avatar_url": "https://example.com/avatar.png",
      "users": [
        {
          "target_object": "users",
          "target_record_id": "5e3fb280-007b-495a-a530-9354bde01de1"
        }
      ],
      "company": {
        "target_object": "companies",
        "target_record_id": "99a03ff3-0435-47da-95cc-76b2caeb4dab"
      }
    }
  }
}'

{
  "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": {
      "workspace_id": [
        {
          "active_from": "2023-01-01T15:00:00.000000000Z",
          "active_until": null,
          "created_by_actor": {
            "type": "system",
            "id": null
          },
          "value": "123",
          "attribute_type": "text"
        }
      ],
      "name": [
        {
          "active_from": "2023-01-01T15:00:00.000000000Z",
          "active_until": null,
          "created_by_actor": {
            "type": "system",
            "id": null
          },
          "value": "Fundstack",
          "attribute_type": "text"
        }
      ],
      "users": [
        {
          "active_from": "2023-01-01T15:00:00.000000000Z",
          "active_until": null,
          "created_by_actor": {
            "type": "system",
            "id": null
          },
          "target_object": "users",
          "target_record_id": "5e3fb280-007b-495a-a530-9354bde01de1",
          "attribute_type": "record-reference"
        }
      ],
      "company": [
        {
          "active_from": "2023-01-01T15:00:00.000000000Z",
          "active_until": null,
          "created_by_actor": {
            "type": "system",
            "id": null
          },
          "target_object": "companies",
          "target_record_id": "99a03ff3-0435-47da-95cc-76b2caeb4dab",
          "attribute_type": "record-reference"
        }
      ],
      "avatar_url": [
        {
          "active_from": "2023-01-01T15:00:00.000000000Z",
          "active_until": null,
          "created_by_actor": {
            "type": "system",
            "id": null
          },
          "value": "https://example.com/avatar.png",
          "attribute_type": "text"
        }
      ]
    }
  }
}

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 workspace already exists. The attribute must be unique. For workspace records, you can use workspace_id or any additional custom attribute with a unique constraint.

Example:

"workspace_id"

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 workspace attribute. For information on potential custom attributes, refer to our attribute type docs.

Example:

{
  "workspace_id": "123",
  "name": "Customer.com",
  "avatar_url": "https://example.com/avatar.png",
  "users": [
    {
      "target_object": "users",
      "target_record_id": "5e3fb280-007b-495a-a530-9354bde01de1"
    }
  ],
  "company": {
    "target_object": "companies",
    "target_record_id": "99a03ff3-0435-47da-95cc-76b2caeb4dab"
  }
}

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 workspace_id or name) can be used, including custom attribute slugs.

data.values.workspace_id

object[]

data.values.workspace_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.workspace_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.workspace_id.created_by_actor

object

required

The actor that created this value.

Example:

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

data.values.workspace_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.workspace_id.attribute_type

enum<string>

required

The attribute type of the value.

Available options:

text

Example:

"text"

data.values.name

object[]

data.values.name.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.name.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.name.created_by_actor

object

required

The actor that created this value.

Example:

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

data.values.name.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.name.attribute_type

enum<string>

required

The attribute type of the value.

Available options:

text

Example:

"text"

data.values.users

object[]

data.values.users.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.users.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.users.created_by_actor

object

required

The actor that created this value.

Example:

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

data.values.users.target_object

string

required

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

Example:

"people"

data.values.users.target_record_id

string

required

A UUID to identify the referenced record.

Example:

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

data.values.users.attribute_type

enum<string>

required

The attribute type of the value.

Available options:

record-reference

Example:

"record-reference"

data.values.company

object[]

data.values.company.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.company.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.company.created_by_actor

object

required

The actor that created this value.

Example:

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

data.values.company.target_object

string

required

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

Example:

"people"

data.values.company.target_record_id

string

required

A UUID to identify the referenced record.

Example:

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

data.values.company.attribute_type

enum<string>

required

The attribute type of the value.

Available options:

record-reference

Example:

"record-reference"

data.values.avatar_url

object[]

data.values.avatar_url.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.avatar_url.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.avatar_url.created_by_actor

object

required

The actor that created this value.

Example:

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

data.values.avatar_url.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.avatar_url.attribute_type

enum<string>

required

The attribute type of the value.

Available options:

text

Example:

"text"

Example:

{
  "workspace_id": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "value": "123",
      "attribute_type": "text"
    }
  ],
  "name": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "value": "Fundstack",
      "attribute_type": "text"
    }
  ],
  "users": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "target_object": "users",
      "target_record_id": "5e3fb280-007b-495a-a530-9354bde01de1",
      "attribute_type": "record-reference"
    }
  ],
  "company": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "target_object": "companies",
      "target_record_id": "99a03ff3-0435-47da-95cc-76b2caeb4dab",
      "attribute_type": "record-reference"
    }
  ],
  "avatar_url": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "value": "https://example.com/avatar.png",
      "attribute_type": "text"
    }
  ]
}

List deal records Create a workspace record

curl --request PUT \
  --url https://api.attio.com/v2/objects/workspaces/records \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "data": {
    "values": {
      "workspace_id": "123",
      "name": "Customer.com",
      "avatar_url": "https://example.com/avatar.png",
      "users": [
        {
          "target_object": "users",
          "target_record_id": "5e3fb280-007b-495a-a530-9354bde01de1"
        }
      ],
      "company": {
        "target_object": "companies",
        "target_record_id": "99a03ff3-0435-47da-95cc-76b2caeb4dab"
      }
    }
  }
}'

{
  "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": {
      "workspace_id": [
        {
          "active_from": "2023-01-01T15:00:00.000000000Z",
          "active_until": null,
          "created_by_actor": {
            "type": "system",
            "id": null
          },
          "value": "123",
          "attribute_type": "text"
        }
      ],
      "name": [
        {
          "active_from": "2023-01-01T15:00:00.000000000Z",
          "active_until": null,
          "created_by_actor": {
            "type": "system",
            "id": null
          },
          "value": "Fundstack",
          "attribute_type": "text"
        }
      ],
      "users": [
        {
          "active_from": "2023-01-01T15:00:00.000000000Z",
          "active_until": null,
          "created_by_actor": {
            "type": "system",
            "id": null
          },
          "target_object": "users",
          "target_record_id": "5e3fb280-007b-495a-a530-9354bde01de1",
          "attribute_type": "record-reference"
        }
      ],
      "company": [
        {
          "active_from": "2023-01-01T15:00:00.000000000Z",
          "active_until": null,
          "created_by_actor": {
            "type": "system",
            "id": null
          },
          "target_object": "companies",
          "target_record_id": "99a03ff3-0435-47da-95cc-76b2caeb4dab",
          "attribute_type": "record-reference"
        }
      ],
      "avatar_url": [
        {
          "active_from": "2023-01-01T15:00:00.000000000Z",
          "active_until": null,
          "created_by_actor": {
            "type": "system",
            "id": null
          },
          "value": "https://example.com/avatar.png",
          "attribute_type": "text"
        }
      ]
    }
  }
}

People

Companies

Users

Deals

Workspaces

Assert a workspace record

Authorizations

Query Parameters

Body

Response