Update a company record

Authorizations

Authorization

string

header

required

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

Path Parameters

record_id

string

required

A UUID of the company record to update.

Example:

"99a03ff3-0435-47da-95cc-76b2caeb4dab"

Body

application/json

data

object

required

Show child attributes

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

Show child attributes

data.values.domains

object[]

Show child attributes

data.values.domains.domain

string

The full domain of the website.

Example:

"app.attio.com"

data.values.name

object[]

Show child attributes

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.description

object[]

Show child attributes

data.values.description.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.twitter

object[]

Show child attributes

data.values.twitter.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.primary_location

object[]

Show child attributes

data.values.primary_location.line_1

string | null

required

The first line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.

Example:

"1 Infinite Loop"

data.values.primary_location.line_2

string | null

required

The second line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.

Example:

"Block 1"

data.values.primary_location.line_3

string | null

required

The third line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.

Example:

"Hilldrop Estate"

data.values.primary_location.line_4

string | null

required

The fourth line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.

Example:

"Westborough"

data.values.primary_location.locality

string | null

required

The town, neighborhood or area the location is in.

Example:

"Cupertino"

data.values.primary_location.region

string | null

required

The state, county, province or region that the location is in.

Example:

"CA"

data.values.primary_location.postcode

string | null

required

The postcode or zip code for the location. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}

Example:

"95014"

data.values.primary_location.country_code

enum<string> | null

required

The ISO 3166-1 alpha-2 country code for the country this location is in.

Available options:

AF,

AX,

AL,

DZ,

AS,

AD,

AO,

AI,

AQ,

AG,

AR,

AM,

AW,

AU,

AT,

AZ,

BS,

BH,

BD,

BB,

BY,

BE,

BZ,

BJ,

BM,

BT,

BO,

BA,

BW,

BV,

BR,

IO,

BN,

BG,

BF,

BI,

KH,

CM,

CA,

CV,

KY,

CF,

TD,

CL,

CN,

CX,

CC,

CO,

KM,

CG,

CD,

CK,

CR,

CI,

HR,

CU,

CW,

CY,

CZ,

DK,

DJ,

DM,

DO,

EC,

EG,

SV,

GQ,

ER,

EE,

ET,

FK,

FO,

FJ,

FI,

FR,

GF,

PF,

TF,

GA,

GM,

GE,

DE,

GH,

GI,

GR,

GL,

GD,

GP,

GU,

GT,

GG,

GN,

GW,

GY,

HT,

HM,

VA,

HN,

HK,

HU,

IS,

IN,

ID,

IR,

IQ,

IE,

IM,

IL,

IT,

JM,

JP,

JE,

JO,

KZ,

KE,

KI,

KR,

KW,

KG,

LA,

LV,

LB,

LS,

LR,

LY,

LI,

LT,

LU,

MO,

MK,

MG,

MW,

MY,

MV,

ML,

MT,

MH,

MQ,

MR,

MU,

YT,

MX,

FM,

MD,

MC,

MN,

ME,

MS,

MA,

MZ,

MM,

NA,

NR,

NP,

NL,

AN,

NC,

NZ,

NI,

NE,

NG,

NU,

NF,

MP,

NO,

OM,

PK,

PW,

PS,

PA,

PG,

PY,

PE,

PH,

PN,

PL,

PT,

PR,

QA,

RE,

RO,

RU,

RW,

BL,

SH,

KN,

LC,

MF,

PM,

VC,

WS,

SM,

ST,

SA,

SN,

SS,

RS,

SC,

SL,

SG,

SK,

SI,

SB,

SO,

ZA,

GS,

ES,

LK,

SD,

SR,

SJ,

SZ,

SE,

CH,

SY,

TW,

TJ,

TZ,

TH,

TL,

TG,

TK,

TO,

TT,

TN,

TR,

TM,

TC,

TV,

UG,

UA,

AE,

GB,

US,

UM,

UY,

UZ,

VU,

VE,

VN,

VG,

VI,

WF,

EH,

YE,

ZM,

ZW,

BQ,

KP,

SX,

XK,

AC

Example:

"US"

data.values.primary_location.latitude

string | null

required

The latitude of the location. Validated by the regular expression /^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?)$/. Values are stored with up to 9 decimal places of precision. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}

Example:

"37.331741"

data.values.primary_location.longitude

string | null

required

The longitude of the location. Validated by the regular expression /^[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$/. Values are stored with up to 9 decimal places of precision. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}

Example:

"-122.030333"

data.values.categories

object[]

Show child attributes

data.values.categories.option

string

required

The UUID or select option title identifying the selected select option.

Minimum string length: 1

Example:

"Medium"

data.values.logo_url

object[]

Show child attributes

data.values.logo_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.twitter_follower_count

object[]

Show child attributes

data.values.twitter_follower_count.value

number

required

Numbers are persisted as 64 bit floats.

Example:

42

data.values.linkedin

object[]

Show child attributes

data.values.linkedin.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.foundation_date

object[]

Show child attributes

data.values.foundation_date.value

string<date>

required

A timestamp value represents a single, universal moment in time using an ISO 8601 formatted string. This means that a timestamp consists of a date, a time (with nanosecond precision), and a time zone. Attio will coerce timestamps which do not provide full nanosecond precision and UTC is assumed if no time zone is provided. For example, "2023", "2023-01", "2023-01-02", "2023-01-02T13:00", "2023-01-02T13:00:00", and "2023-01-02T13:00:00.000000000" will all be coerced to "2023-01-02T13:00:00.000000000Z". Timestamps are always returned in UTC. For example, writing a timestamp value using the string "2023-01-02T13:00:00.000000000+02:00" will result in the value "2023-01-02T11:00:00.000000000Z" being returned. The maximum date is "9999-12-31T23:59:59.999999999Z".

Example:

"2023-01-01T15:00:00.000000000Z"

data.values.estimated_arr_usd

object[]

Show child attributes

data.values.estimated_arr_usd.option

string

required

The UUID or select option title identifying the selected select option.

Minimum string length: 1

Example:

"Medium"

data.values.employee_range

object[]

Show child attributes

data.values.employee_range.option

string

required

The UUID or select option title identifying the selected select option.

Minimum string length: 1

Example:

"Medium"

data.values.angellist

object[]

Show child attributes

data.values.angellist.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.facebook

object[]

Show child attributes

data.values.facebook.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.instagram

object[]

Show child attributes

data.values.instagram.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.team

object[]

Option 1
Option 2

Show child attributes

data.values.team.target_object

string

required

A UUID or slug to identify the object that the referenced record belongs to.

Example:

"people"

data.values.team.target_record_id

string<uuid>

required

A UUID to identify the referenced record.

Example:

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

Example:

{
  "target_object": "people",
  "target_record_id": "891dcbfc-9141-415d-9b2a-2238a6cc012d"
}

Example:

{
  "domains": ["attio.com"],
  "name": "Attio",
  "description": "Customer relationship magic",
  "team": ["[email protected]"],
  "primary_location": "1 Infinite Loop, Cupertino, CA, 95014, US"
}

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 record belongs to.

Example:

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

data.id.object_id

string<uuid>

required

A UUID identifying the object this record belongs to.

Example:

"97052eb9-e65e-443f-a297-f2d9a4a7f795"

data.id.record_id

string<uuid>

required

A UUID identifying this record.

Example:

"bf071e1f-6035-429d-b874-d83ea64ea13b"

data.created_at

string

required

When this record was created.

Example:

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

data.web_url

string<uri>

required

A URL that links directly to the record page in the Attio web application.

Example:

"https://app.attio.com/salarya/person/bf071e1f-6035-429d-b874-d83ea64ea13b"

data.values

object

required

An object with attribute_slug keys, and an array of value objects as the values. Attributes slugs (for example domains or name) can be used, including custom attribute slugs.

Show child attributes

data.values.domains

object[]

Show child attributes

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

object

required

The actor that created this value.

Show child attributes

data.values.domains.created_by_actor.id

string | null

An ID to identify the actor.

data.values.domains.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.values.domains.domain

string

required

Example:

"app.attio.com"

data.values.domains.root_domain

string

required

Example:

"attio.com"

data.values.domains.attribute_type

enum<string>

required

The attribute type of the value.

Available options:

domain

Example:

"domain"

data.values.name

object[]

Show child attributes

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

object

required

The actor that created this value.

Show child attributes

data.values.name.created_by_actor.id

string | null

An ID to identify the actor.

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

object[]

Show child attributes

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

object

required

The actor that created this value.

Show child attributes

data.values.description.created_by_actor.id

string | null

An ID to identify the actor.

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

enum<string>

required

The attribute type of the value.

Available options:

text

Example:

"text"

data.values.twitter

object[]

Show child attributes

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

object

required

The actor that created this value.

Show child attributes

data.values.twitter.created_by_actor.id

string | null

An ID to identify the actor.

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

enum<string>

required

The attribute type of the value.

Available options:

text

Example:

"text"

data.values.team

object[]

Show child attributes

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

object

required

The actor that created this value.

Show child attributes

data.values.team.created_by_actor.id

string | null

An ID to identify the actor.

data.values.team.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.values.team.target_object

string

required

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

Example:

"people"

data.values.team.target_record_id

string<uuid>

required

A UUID to identify the referenced record.

Example:

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

data.values.team.attribute_type

enum<string>

required

The attribute type of the value.

Available options:

record-reference

Example:

"record-reference"

data.values.primary_location

object[]

Show child attributes

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

object

required

The actor that created this value.

Show child attributes

data.values.primary_location.created_by_actor.id

string | null

An ID to identify the actor.

data.values.primary_location.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.values.primary_location.line_1

string | null

required

The first line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.

Example:

"1 Infinite Loop"

data.values.primary_location.line_2

string | null

required

The second line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.

Example:

"Block 1"

data.values.primary_location.line_3

string | null

required

The third line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.

Example:

"Hilldrop Estate"

data.values.primary_location.line_4

string | null

required

The fourth line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.

Example:

"Westborough"

data.values.primary_location.locality

string | null

required

The town, neighborhood or area the location is in.

Example:

"Cupertino"

data.values.primary_location.region

string | null

required

The state, county, province or region that the location is in.

Example:

"CA"

data.values.primary_location.postcode

string | null

required

The postcode or zip code for the location. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}

Example:

"95014"

data.values.primary_location.country_code

enum<string> | null

required

The ISO 3166-1 alpha-2 country code for the country this location is in.

Available options:

AF,

AX,

AL,

DZ,

AS,

AD,

AO,

AI,

AQ,

AG,

AR,

AM,

AW,

AU,

AT,

AZ,

BS,

BH,

BD,

BB,

BY,

BE,

BZ,

BJ,

BM,

BT,

BO,

BA,

BW,

BV,

BR,

IO,

BN,

BG,

BF,

BI,

KH,

CM,

CA,

CV,

KY,

CF,

TD,

CL,

CN,

CX,

CC,

CO,

KM,

CG,

CD,

CK,

CR,

CI,

HR,

CU,

CW,

CY,

CZ,

DK,

DJ,

DM,

DO,

EC,

EG,

SV,

GQ,

ER,

EE,

ET,

FK,

FO,

FJ,

FI,

FR,

GF,

PF,

TF,

GA,

GM,

GE,

DE,

GH,

GI,

GR,

GL,

GD,

GP,

GU,

GT,

GG,

GN,

GW,

GY,

HT,

HM,

VA,

HN,

HK,

HU,

IS,

IN,

ID,

IR,

IQ,

IE,

IM,

IL,

IT,

JM,

JP,

JE,

JO,

KZ,

KE,

KI,

KR,

KW,

KG,

LA,

LV,

LB,

LS,

LR,

LY,

LI,

LT,

LU,

MO,

MK,

MG,

MW,

MY,

MV,

ML,

MT,

MH,

MQ,

MR,

MU,

YT,

MX,

FM,

MD,

MC,

MN,

ME,

MS,

MA,

MZ,

MM,

NA,

NR,

NP,

NL,

AN,

NC,

NZ,

NI,

NE,

NG,

NU,

NF,

MP,

NO,

OM,

PK,

PW,

PS,

PA,

PG,

PY,

PE,

PH,

PN,

PL,

PT,

PR,

QA,

RE,

RO,

RU,

RW,

BL,

SH,

KN,

LC,

MF,

PM,

VC,

WS,

SM,

ST,

SA,

SN,

SS,

RS,

SC,

SL,

SG,

SK,

SI,

SB,

SO,

ZA,

GS,

ES,

LK,

SD,

SR,

SJ,

SZ,

SE,

CH,

SY,

TW,

TJ,

TZ,

TH,

TL,

TG,

TK,

TO,

TT,

TN,

TR,

TM,

TC,

TV,

UG,

UA,

AE,

GB,

US,

UM,

UY,

UZ,

VU,

VE,

VN,

VG,

VI,

WF,

EH,

YE,

ZM,

ZW,

BQ,

KP,

SX,

XK,

AC

Example:

"US"

data.values.primary_location.latitude

string | null

required

Example:

"37.331741"

data.values.primary_location.longitude

string | null

required

Example:

"-122.030333"

data.values.primary_location.attribute_type

enum<string>

required

The attribute type of the value.

Available options:

location

Example:

"location"

data.values.last_email_interaction

object[]

Show child attributes

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

object

required

The actor that created this value.

Show child attributes

data.values.last_email_interaction.created_by_actor.id

string | null

An ID to identify the actor.

data.values.last_email_interaction.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.values.last_email_interaction.interaction_type

enum<string>

required

The type of interaction e.g. calendar or email.

Available options:

calendar-event,

call,

chat-thread,

email,

in-person-meeting,

meeting

Example:

"email"

data.values.last_email_interaction.interacted_at

string<date-time>

required

When the interaction occurred.

Example:

"2023-01-01T15:00:00.000000000Z"

data.values.last_email_interaction.owner_actor

object

required

The actor that created this value.

Show child attributes

data.values.last_email_interaction.owner_actor.id

string | null

An ID to identify the actor.

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

enum<string>

required

The attribute type of the value.

Available options:

interaction

Example:

"interaction"

data.values.categories

object[]

Show child attributes

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

object

required

The actor that created this value.

Show child attributes

data.values.categories.created_by_actor.id

string | null

An ID to identify the actor.

data.values.categories.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.values.categories.option

object

required

Show child attributes

data.values.categories.option.id

object

required

Show child attributes

data.values.categories.option.id.workspace_id

string<uuid>

required

The ID of the workspace

Example:

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

data.values.categories.option.id.object_id

string<uuid>

required

The ID of the object

Example:

"97052eb9-e65e-443f-a297-f2d9a4a7f795"

data.values.categories.option.id.attribute_id

string<uuid>

required

The ID of the attribute

Example:

"41252299-f8c7-4b5e-99c9-4ff8321d2f96"

data.values.categories.option.id.option_id

string<uuid>

required

The ID of the select option

Example:

"08c2c59a-c18e-40c6-8dc4-95415313b2ea"

data.values.categories.option.title

string

required

The title of the select option

Example:

"Medium"

data.values.categories.option.is_archived

boolean

required

Whether or not to archive the select option. See our archiving guide for more information on archiving.

Example:

false

data.values.categories.attribute_type

enum<string>

required

The attribute type of the value.

Available options:

select

Example:

"select"

data.values.logo_url

object[]

Show child attributes

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

object

required

The actor that created this value.

Show child attributes

data.values.logo_url.created_by_actor.id

string | null

An ID to identify the actor.

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

enum<string>

required

The attribute type of the value.

Available options:

text

Example:

"text"

data.values.twitter_follower_count

object[]

Show child attributes

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

object

required

The actor that created this value.

Show child attributes

data.values.twitter_follower_count.created_by_actor.id

string | null

An ID to identify the actor.

data.values.twitter_follower_count.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.values.twitter_follower_count.value

number

required

Numbers are persisted as 64 bit floats.

Example:

42

data.values.twitter_follower_count.attribute_type

enum<string>

required

The attribute type of the value.

Available options:

number

Example:

"number"

data.values.last_calendar_interaction

object[]

Show child attributes

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

object

required

The actor that created this value.

Show child attributes

data.values.last_calendar_interaction.created_by_actor.id

string | null

An ID to identify the actor.

data.values.last_calendar_interaction.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.values.last_calendar_interaction.interaction_type

enum<string>

required

The type of interaction e.g. calendar or email.

Available options:

calendar-event,

call,

chat-thread,

email,

in-person-meeting,

meeting

Example:

"email"

data.values.last_calendar_interaction.interacted_at

string<date-time>

required

When the interaction occurred.

Example:

"2023-01-01T15:00:00.000000000Z"

data.values.last_calendar_interaction.owner_actor

object

required

The actor that created this value.

Show child attributes

data.values.last_calendar_interaction.owner_actor.id

string | null

An ID to identify the actor.

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

enum<string>

required

The attribute type of the value.

Available options:

interaction

Example:

"interaction"

data.values.linkedin

object[]

Show child attributes

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

object

required

The actor that created this value.

Show child attributes

data.values.linkedin.created_by_actor.id

string | null

An ID to identify the actor.

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

enum<string>

required

The attribute type of the value.

Available options:

text

Example:

"text"

data.values.foundation_date

object[]

Show child attributes

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

object

required

The actor that created this value.

Show child attributes

data.values.foundation_date.created_by_actor.id

string | null

An ID to identify the actor.

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

enum<string>

required

The attribute type of the value.

Available options:

date

Example:

"date"

data.values.foundation_date.value

string

required

A date represents a single calendar year, month and day, independent of timezone. If hours, months, seconds or timezones are provided, they will be trimmed. For example, "2023" and "2023-01" will be coerced into "2023-01-01", and "2023-01-02", "2023-01-02T13:00", "2023-01-02T14:00:00", "2023-01-02T15:00:00.000000000", and "2023-01-02T15:00:00.000000000+02:00" will all be coerced to "2023-01-02". If a timezone is provided that would result in a different calendar date in UTC, the date will be coerced to UTC and then the timezone component will be trimmed. For example, the value "2023-01-02T23:00:00-10:00" will be returned as "2023-01-03". The maximum date is "9999-12-31".

Example:

"2023-01-01"

data.values.strongest_connection_user

object[]

Show child attributes

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

object

required

The actor that created this value.

Show child attributes

data.values.strongest_connection_user.created_by_actor.id

string | null

An ID to identify the actor.

data.values.strongest_connection_user.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.values.strongest_connection_user.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.values.strongest_connection_user.referenced_actor_id

string<uuid> | null

required

The ID of the referenced actor.

Example:

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

data.values.strongest_connection_user.attribute_type

enum<string>

required

The attribute type of the value.

Available options:

actor-reference

Example:

"actor-reference"

data.values.estimated_arr_usd

object[]

Show child attributes

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

object

required

The actor that created this value.

Show child attributes

data.values.estimated_arr_usd.created_by_actor.id

string | null

An ID to identify the actor.

data.values.estimated_arr_usd.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.values.estimated_arr_usd.option

object

required

Show child attributes

data.values.estimated_arr_usd.option.id

object

required

Show child attributes

data.values.estimated_arr_usd.option.id.workspace_id

string<uuid>

required

The ID of the workspace

Example:

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

data.values.estimated_arr_usd.option.id.object_id

string<uuid>

required

The ID of the object

Example:

"97052eb9-e65e-443f-a297-f2d9a4a7f795"

data.values.estimated_arr_usd.option.id.attribute_id

string<uuid>

required

The ID of the attribute

Example:

"41252299-f8c7-4b5e-99c9-4ff8321d2f96"

data.values.estimated_arr_usd.option.id.option_id

string<uuid>

required

The ID of the select option

Example:

"08c2c59a-c18e-40c6-8dc4-95415313b2ea"

data.values.estimated_arr_usd.option.title

string

required

The title of the select option

Example:

"Medium"

data.values.estimated_arr_usd.option.is_archived

boolean

required

Whether or not to archive the select option. See our archiving guide for more information on archiving.

Example:

false

data.values.estimated_arr_usd.attribute_type

enum<string>

required

The attribute type of the value.

Available options:

select

Example:

"select"

data.values.strongest_connection_strength_legacy

object[]

Show child attributes

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

object

required

The actor that created this value.

Show child attributes

data.values.strongest_connection_strength_legacy.created_by_actor.id

string | null

An ID to identify the actor.

data.values.strongest_connection_strength_legacy.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.values.strongest_connection_strength_legacy.value

number

required

Numbers are persisted as 64 bit floats.

Example:

42

data.values.strongest_connection_strength_legacy.attribute_type

enum<string>

required

The attribute type of the value.

Available options:

number

Example:

"number"

data.values.next_calendar_interaction

object[]

Show child attributes

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

object

required

The actor that created this value.

Show child attributes

data.values.next_calendar_interaction.created_by_actor.id

string | null

An ID to identify the actor.

data.values.next_calendar_interaction.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.values.next_calendar_interaction.interaction_type

enum<string>

required

The type of interaction e.g. calendar or email.

Available options:

calendar-event,

call,

chat-thread,

email,

in-person-meeting,

meeting

Example:

"email"

data.values.next_calendar_interaction.interacted_at

string<date-time>

required

When the interaction occurred.

Example:

"2023-01-01T15:00:00.000000000Z"

data.values.next_calendar_interaction.owner_actor

object

required

The actor that created this value.

Show child attributes

data.values.next_calendar_interaction.owner_actor.id

string | null

An ID to identify the actor.

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

enum<string>

required

The attribute type of the value.

Available options:

interaction

Example:

"interaction"

data.values.employee_range

object[]

Show child attributes

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

object

required

The actor that created this value.

Show child attributes

data.values.employee_range.created_by_actor.id

string | null

An ID to identify the actor.

data.values.employee_range.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.values.employee_range.option

object

required

Show child attributes

data.values.employee_range.option.id

object

required

Show child attributes

data.values.employee_range.option.id.workspace_id

string<uuid>

required

The ID of the workspace

Example:

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

data.values.employee_range.option.id.object_id

string<uuid>

required

The ID of the object

Example:

"97052eb9-e65e-443f-a297-f2d9a4a7f795"

data.values.employee_range.option.id.attribute_id

string<uuid>

required

The ID of the attribute

Example:

"41252299-f8c7-4b5e-99c9-4ff8321d2f96"

data.values.employee_range.option.id.option_id

string<uuid>

required

The ID of the select option

Example:

"08c2c59a-c18e-40c6-8dc4-95415313b2ea"

data.values.employee_range.option.title

string

required

The title of the select option

Example:

"Medium"

data.values.employee_range.option.is_archived

boolean

required

Whether or not to archive the select option. See our archiving guide for more information on archiving.

Example:

false

data.values.employee_range.attribute_type

enum<string>

required

The attribute type of the value.

Available options:

select

Example:

"select"

data.values.first_interaction

object[]

Show child attributes

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

object

required

The actor that created this value.

Show child attributes

data.values.first_interaction.created_by_actor.id

string | null

An ID to identify the actor.

data.values.first_interaction.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.values.first_interaction.interaction_type

enum<string>

required

The type of interaction e.g. calendar or email.

Available options:

calendar-event,

call,

chat-thread,

email,

in-person-meeting,

meeting

Example:

"email"

data.values.first_interaction.interacted_at

string<date-time>

required

When the interaction occurred.

Example:

"2023-01-01T15:00:00.000000000Z"

data.values.first_interaction.owner_actor

object

required

The actor that created this value.

Show child attributes

data.values.first_interaction.owner_actor.id

string | null

An ID to identify the actor.

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

enum<string>

required

The attribute type of the value.

Available options:

interaction

Example:

"interaction"

data.values.angellist

object[]

Show child attributes

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

object

required

The actor that created this value.

Show child attributes

data.values.angellist.created_by_actor.id

string | null

An ID to identify the actor.

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

enum<string>

required

The attribute type of the value.

Available options:

text

Example:

"text"

data.values.facebook

object[]

Show child attributes

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

object

required

The actor that created this value.

Show child attributes

data.values.facebook.created_by_actor.id

string | null

An ID to identify the actor.

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

enum<string>

required

The attribute type of the value.

Available options:

text

Example:

"text"

data.values.first_email_interaction

object[]

Show child attributes

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

object

required

The actor that created this value.

Show child attributes

data.values.first_email_interaction.created_by_actor.id

string | null

An ID to identify the actor.

data.values.first_email_interaction.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.values.first_email_interaction.interaction_type

enum<string>

required

The type of interaction e.g. calendar or email.

Available options:

calendar-event,

call,

chat-thread,

email,

in-person-meeting,

meeting

Example:

"email"

data.values.first_email_interaction.interacted_at

string<date-time>

required

When the interaction occurred.

Example:

"2023-01-01T15:00:00.000000000Z"

data.values.first_email_interaction.owner_actor

object

required

The actor that created this value.

Show child attributes

data.values.first_email_interaction.owner_actor.id

string | null

An ID to identify the actor.

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

enum<string>

required

The attribute type of the value.

Available options:

interaction

Example:

"interaction"

data.values.strongest_connection_strength

object[]

Show child attributes

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

object

required

The actor that created this value.

Show child attributes

data.values.strongest_connection_strength.created_by_actor.id

string | null

An ID to identify the actor.

data.values.strongest_connection_strength.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.values.strongest_connection_strength.option

object

required

Show child attributes

data.values.strongest_connection_strength.option.id

object

required

Show child attributes

data.values.strongest_connection_strength.option.id.workspace_id

string<uuid>

required

The ID of the workspace

Example:

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

data.values.strongest_connection_strength.option.id.object_id

string<uuid>

required

The ID of the object

Example:

"97052eb9-e65e-443f-a297-f2d9a4a7f795"

data.values.strongest_connection_strength.option.id.attribute_id

string<uuid>

required

The ID of the attribute

Example:

"41252299-f8c7-4b5e-99c9-4ff8321d2f96"

data.values.strongest_connection_strength.option.id.option_id

string<uuid>

required

The ID of the select option

Example:

"08c2c59a-c18e-40c6-8dc4-95415313b2ea"

data.values.strongest_connection_strength.option.title

string

required

The title of the select option

Example:

"Medium"

data.values.strongest_connection_strength.option.is_archived

boolean

required

Whether or not to archive the select option. See our archiving guide for more information on archiving.

Example:

false

data.values.strongest_connection_strength.attribute_type

enum<string>

required

The attribute type of the value.

Available options:

select

Example:

"select"

data.values.first_calendar_interaction

object[]

Show child attributes

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

object

required

The actor that created this value.

Show child attributes

data.values.first_calendar_interaction.created_by_actor.id

string | null

An ID to identify the actor.

data.values.first_calendar_interaction.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.values.first_calendar_interaction.interaction_type

enum<string>

required

The type of interaction e.g. calendar or email.

Available options:

calendar-event,

call,

chat-thread,

email,

in-person-meeting,

meeting

Example:

"email"

data.values.first_calendar_interaction.interacted_at

string<date-time>

required

When the interaction occurred.

Example:

"2023-01-01T15:00:00.000000000Z"

data.values.first_calendar_interaction.owner_actor

object

required

The actor that created this value.

Show child attributes

data.values.first_calendar_interaction.owner_actor.id

string | null

An ID to identify the actor.

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

enum<string>

required

The attribute type of the value.

Available options:

interaction

Example:

"interaction"

data.values.instagram

object[]

Show child attributes

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

object

required

The actor that created this value.

Show child attributes

data.values.instagram.created_by_actor.id

string | null

An ID to identify the actor.

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

enum<string>

required

The attribute type of the value.

Available options:

text

Example:

"text"

data.values.last_interaction

object[]

Show child attributes

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

object

required

The actor that created this value.

Show child attributes

data.values.last_interaction.created_by_actor.id

string | null

An ID to identify the actor.

data.values.last_interaction.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.values.last_interaction.interaction_type

enum<string>

required

The type of interaction e.g. calendar or email.

Available options:

calendar-event,

call,

chat-thread,

email,

in-person-meeting,

meeting

Example:

"email"

data.values.last_interaction.interacted_at

string<date-time>

required

When the interaction occurred.

Example:

"2023-01-01T15:00:00.000000000Z"

data.values.last_interaction.owner_actor

object

required

The actor that created this value.

Show child attributes

data.values.last_interaction.owner_actor.id

string | null

An ID to identify the actor.

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

enum<string>

required

The attribute type of the value.

Available options:

interaction

Example:

"interaction"

data.values.created_at

object[]

Show child attributes

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

object

required

The actor that created this value.

Show child attributes

data.values.created_at.created_by_actor.id

string | null

An ID to identify the actor.

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

enum<string>

required

The attribute type of the value.

Available options:

timestamp

Example:

"timestamp"

data.values.created_at.value

string<date>

required

Example:

"2023-01-01T15:00:00.000000000Z"

Example:

{
  "domains": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": {
        "type": "workspace-member",
        "id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64"
      },
      "domain": "attio.com",
      "root_domain": "attio.com",
      "attribute_type": "domain"
    }
  ],
  "name": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": {
        "type": "workspace-member",
        "id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64"
      },
      "value": "Attio",
      "attribute_type": "text"
    }
  ],
  "description": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": {
        "type": "workspace-member",
        "id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64"
      },
      "value": "Customer relationship magic",
      "attribute_type": "text"
    }
  ],
  "team": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "target_object": "people",
      "target_record_id": "121e50c2-65a3-449e-8397-c4d083d1e2e4",
      "attribute_type": "record-reference"
    }
  ],
  "primary_location": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "country_code": "GB",
      "line_1": null,
      "line_2": null,
      "line_3": null,
      "line_4": null,
      "locality": "London",
      "region": null,
      "latitude": null,
      "longitude": null,
      "postcode": null,
      "attribute_type": "location"
    }
  ],
  "categories": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "option": {
        "id": {
          "workspace_id": "ca10906c-6785-464e-bb6c-b003e63c6a18",
          "object_id": "cf49cf53-dbb4-4d18-87fc-28aba21d7a49",
          "attribute_id": "7914c8c4-34b1-42b6-9e4c-4db8baa58bfa",
          "option_id": "e37175a9-94f3-410f-bb29-78287bc1c444"
        },
        "title": "B2B",
        "is_archived": false
      },
      "attribute_type": "select"
    }
  ],
  "logo_url": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "value": "https://d1ts43dypk8bqh.cloudfront.net/v1/avatars/b792e7f9-003d-494f-a7b4-a53251c621e6",
      "attribute_type": "text"
    }
  ],
  "twitter_follower_count": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "value": 100,
      "attribute_type": "number"
    }
  ],
  "foundation_date": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "value": "2023-01-01",
      "attribute_type": "date"
    }
  ],
  "strongest_connection_user": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "referenced_actor_type": "workspace-member",
      "referenced_actor_id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64",
      "attribute_type": "actor-reference"
    }
  ],
  "estimated_arr_usd": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "option": {
        "id": {
          "workspace_id": "ca10906c-6785-464e-bb6c-b003e63c6a18",
          "object_id": "cf49cf53-dbb4-4d18-87fc-28aba21d7a49",
          "attribute_id": "5678c8c4-34b1-42b6-9e4c-4db8baa58u7f",
          "option_id": "g73565a9-94f3-410f-bb29-78287bc1c715"
        },
        "title": "$500M-$1B",
        "is_archived": false
      },
      "attribute_type": "select"
    }
  ],
  "strongest_connection_strength_legacy": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "value": 54.725113205693695,
      "attribute_type": "number"
    }
  ],
  "employee_range": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "option": {
        "id": {
          "workspace_id": "ca10906c-6785-464e-bb6c-b003e63c6a18",
          "object_id": "cf49cf53-dbb4-4d18-87fc-28aba21d7a49",
          "attribute_id": "8264c8c4-34b1-42b6-9e4c-4db8baa58d6b",
          "option_id": "gh65s5a9-94f3-410f-bb29-78287bc1c856"
        },
        "title": "51-250",
        "is_archived": false
      },
      "attribute_type": "select"
    }
  ],
  "twitter": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "value": "https://x.com/attio",
      "attribute_type": "text"
    }
  ],
  "angellist": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "value": "https://angellist.com/attio",
      "attribute_type": "text"
    }
  ],
  "facebook": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "value": "https://facebook.com/attio",
      "attribute_type": "text"
    }
  ],
  "linkedin": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "value": "https://linkedin.com/in/attio",
      "attribute_type": "text"
    }
  ],
  "instagram": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "value": "https://instagram.com/attio",
      "attribute_type": "text"
    }
  ],
  "strongest_connection_strength": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "option": {
        "id": {
          "workspace_id": "ca10906c-6785-464e-bb6c-b003e63c6a18",
          "object_id": "cf49cf53-dbb4-4d18-87fc-28aba21d7a49",
          "attribute_id": "7914c8c4-34b1-42b6-9e4c-4db8baa58bfa",
          "option_id": "e37175a9-94f3-410f-bb29-78287bc1c444"
        },
        "title": "Very strong",
        "is_archived": false
      },
      "attribute_type": "select"
    }
  ],
  "last_calendar_interaction": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "interaction_type": "email",
      "interacted_at": "2023-01-01T15:00:00.000000000Z",
      "owner_actor": {
        "type": "workspace-member",
        "id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64"
      },
      "attribute_type": "interaction"
    }
  ],
  "last_email_interaction": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "interaction_type": "email",
      "interacted_at": "2023-01-01T15:00:00.000000000Z",
      "owner_actor": {
        "type": "workspace-member",
        "id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64"
      },
      "attribute_type": "interaction"
    }
  ],
  "first_interaction": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "interaction_type": "email",
      "interacted_at": "2023-01-01T15:00:00.000000000Z",
      "owner_actor": {
        "type": "workspace-member",
        "id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64"
      },
      "attribute_type": "interaction"
    }
  ],
  "first_email_interaction": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "interaction_type": "email",
      "interacted_at": "2023-01-01T15:00:00.000000000Z",
      "owner_actor": {
        "type": "workspace-member",
        "id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64"
      },
      "attribute_type": "interaction"
    }
  ],
  "first_calendar_interaction": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "interaction_type": "email",
      "interacted_at": "2023-01-01T15:00:00.000000000Z",
      "owner_actor": {
        "type": "workspace-member",
        "id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64"
      },
      "attribute_type": "interaction"
    }
  ],
  "next_calendar_interaction": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "interaction_type": "email",
      "interacted_at": "2023-01-01T15:00:00.000000000Z",
      "owner_actor": {
        "type": "workspace-member",
        "id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64"
      },
      "attribute_type": "interaction"
    }
  ],
  "last_interaction": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "interaction_type": "email",
      "interacted_at": "2023-01-01T15:00:00.000000000Z",
      "owner_actor": {
        "type": "workspace-member",
        "id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64"
      },
      "attribute_type": "interaction"
    }
  ],
  "created_at": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "value": "2022-07-11T11:51:47.182000000Z",
      "attribute_type": "timestamp"
    }
  ],
  "created_by": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "referenced_actor_type": "workspace-member",
      "referenced_actor_id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64",
      "attribute_type": "actor-reference"
    }
  ]
}

Introduction

Guides

Tutorials

Endpoint reference

Webhook reference

Update a company record

Authorizations

Path Parameters

Body

Response