Assert a deal record

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 deal already exists. The attribute must be unique. There is no unique attribute on deals by default, so you should add your own.

Example:

"custom_deal_attribute"

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

Show child attributes

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

object[]

Show child attributes

data.values.stage.status

string

required

The UUID or status title identifying the selected status.

Minimum string length: 1

Example:

"In Progress"

data.values.owner

object[]

Option 1
Option 2

Show child attributes

data.values.owner.referenced_actor_type

enum<string>

required

The type of the referenced actor. Currently, only workspace members can be written into actor reference attributes. Read more information on actor types here.

Available options:

workspace-member

Example:

"workspace-member"

data.values.owner.referenced_actor_id

string<uuid>

required

The ID of the referenced Actor.

Example:

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

data.values.value

object[]

Show child attributes

data.values.value.currency_value

number

required

A numerical representation of the currency value. A decimal with a max of 4 decimal places.

Example:

99

data.values.associated_people

object[]

Option 1
Option 2

Show child attributes

data.values.associated_people.target_object

string

required

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

Example:

"people"

data.values.associated_people.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"
}

data.values.associated_company

object[]

Option 1
Option 2

Show child attributes

data.values.associated_company.target_object

string

required

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

Example:

"people"

data.values.associated_company.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:

{
  "name": "Contract with Fundstack",
  "stage": "In Progress",
  "owner": "[email protected]",
  "value": 4200,
  "associated_people": [
    {
      "target_object": "people",
      "email_addresses": [{ "email_address": "[email protected]" }]
    }
  ],
  "associated_company": {
    "target_object": "companies",
    "domains": [{ "domain": "company.com" }]
  }
}

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

Show child attributes

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

object[]

Show child attributes

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

object

required

The actor that created this value.

Show child attributes

data.values.stage.created_by_actor.id

string | null

An ID to identify the actor.

data.values.stage.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.stage.status

object

required

Show child attributes

data.values.stage.status.id

object

required

Show child attributes

data.values.stage.status.id.workspace_id

string<uuid>

required

The ID of the workspace

Example:

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

data.values.stage.status.id.object_id

string<uuid>

required

The ID of the object

Example:

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

data.values.stage.status.id.attribute_id

string<uuid>

required

The ID of the attribute

Example:

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

data.values.stage.status.id.status_id

string<uuid>

required

The ID of the status

Example:

"11f07f01-c10f-4e05-a522-33e050bc52ee"

data.values.stage.status.title

string

required

The title of the status

Example:

"In Progress"

data.values.stage.status.is_archived

boolean

required

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

Example:

false

data.values.stage.status.celebration_enabled

boolean

required

Whether arriving at this status triggers a celebration effect in the UI

Example:

false

data.values.stage.status.target_time_in_status

string | null

required

Target time for a record to spend in given status expressed as a ISO-8601 duration string

Example:

"P0Y0M1DT0H0M0S"

data.values.stage.attribute_type

enum<string>

required

The attribute type of the value.

Available options:

status

Example:

"status"

data.values.owner

object[]

Show child attributes

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

object

required

The actor that created this value.

Show child attributes

data.values.owner.created_by_actor.id

string | null

An ID to identify the actor.

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

string<uuid> | null

required

The ID of the referenced actor.

Example:

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

data.values.owner.attribute_type

enum<string>

required

The attribute type of the value.

Available options:

actor-reference

Example:

"actor-reference"

data.values.value

object[]

Show child attributes

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

object

required

The actor that created this value.

Show child attributes

data.values.value.created_by_actor.id

string | null

An ID to identify the actor.

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

number

required

A numerical representation of the currency value. A decimal with a max of 4 decimal places.

Example:

99

data.values.value.attribute_type

enum<string>

required

The attribute type of the value.

Available options:

currency

Example:

"currency"

data.values.value.currency_code

enum<string> | null

The ISO4217 currency code representing the currency that the value is stored in.

Available options:

ARS,

AUD,

BRL,

BGN,

CAD,

CLP,

CNY,

COP,

CZK,

DKK,

EUR,

HKD,

ISK,

INR,

ILS,

JPY,

KRW,

MYR,

MXN,

NTD,

NZD,

NGN,

NOK,

XPF,

PEN,

PHP,

PLN,

GBP,

RWF,

SAR,

SGD,

ZAR,

SEK,

CHF,

THB,

AED,

UYU,

USD

Example:

"USD"

data.values.associated_people

object[]

Show child attributes

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

object

required

The actor that created this value.

Show child attributes

data.values.associated_people.created_by_actor.id

string | null

An ID to identify the actor.

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

string

required

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

Example:

"people"

data.values.associated_people.target_record_id

string<uuid>

required

A UUID to identify the referenced record.

Example:

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

data.values.associated_people.attribute_type

enum<string>

required

The attribute type of the value.

Available options:

record-reference

Example:

"record-reference"

data.values.associated_company

object[]

Show child attributes

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

object

required

The actor that created this value.

Show child attributes

data.values.associated_company.created_by_actor.id

string | null

An ID to identify the actor.

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

string

required

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

Example:

"people"

data.values.associated_company.target_record_id

string<uuid>

required

A UUID to identify the referenced record.

Example:

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

data.values.associated_company.attribute_type

enum<string>

required

The attribute type of the value.

Available options:

record-reference

Example:

"record-reference"

Example:

{
  "name": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "value": "Contract with Fundstack",
      "attribute_type": "text"
    }
  ],
  "stage": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "status": {
        "title": "In Progress",
        "id": {
          "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
          "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
          "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96",
          "status_id": "11f07f01-c10f-4e05-a522-33e050bc52ee"
        },
        "is_archived": false,
        "celebration_enabled": false,
        "target_time_in_status": null
      },
      "attribute_type": "status"
    }
  ],
  "owner": [
    {
      "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": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
      "attribute_type": "actor-reference"
    }
  ],
  "value": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "currency_value": 4200,
      "currency_code": "USD",
      "attribute_type": "currency"
    }
  ],
  "associated_people": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "target_object": "people",
      "target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b",
      "attribute_type": "record-reference"
    }
  ],
  "associated_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": "bf071e1f-6035-429d-b874-d83ea64ea13b",
      "attribute_type": "record-reference"
    }
  ]
}

Introduction

Guides

Tutorials

Endpoint reference

Webhook reference

Assert a deal record

Authorizations

Query Parameters

Body

Response