Developers
Set your API contextPick a region and space ID once. Every sample fills in your base URL.
Where do I find these?

In Coevera: open your space's API application and choose Show Access. It shows the space ID and the base URL, whose host starts with your region.

From the API: if you know the space ID, the discovery endpoint GET /api/discovery/spaces/{space_id} returns its region and base URLs, without credentials.

Only the region and space ID are kept, in this browser. Never paste a key or password here.

More in the quickstart

REST APIAccountsAccounts

Accounts

Companies and organisations you sell to. An account owns its contact relations, opportunities and activities.

Each account has an owner (a Client, the API's name for a user) and a sales unit, which decide who can see it. Contacts are linked to accounts through ContactAccountRelations. Accounts and contacts are the two entities that can be merged.

MethodPathOperation
GET/entities/AccountsList accounts
POST/entities/AccountsCreate an account
GET/entities/Accounts/{id}Get an account
PATCH/entities/Accounts/{id}Update an account
DEL/entities/Accounts/{id}Delete an account
POST/entities/Accounts/batch-modifyCreate or update accounts in a batch
POST/entities/Accounts/batch-deleteDelete accounts in a batch
POST/entities/Accounts/batch-restoreRestore deleted accounts
POST/entities/Accounts/mergeMerge accounts

GET List accounts

Returns the accounts the API application can read, one page at a time. In the list envelope, total counts every match; page forward with after set to page_info.end_cursor until has_next_page is false.

Query parameters

NameTypeDescription
include-deletedbooleanInclude soft-deleted records. Lists only; get-by-id refuses it.
firstintegerPage size. Default 30, maximum 100; a larger value is refused with HTTP 400, code 117.
lastintegerReturn the last N records of the result; together with first, the last N of the first M. Maximum 100.
beforestringCursor from page_info.start_cursor, to page backwards. URL-encode it.
afterstringCursor from page_info.end_cursor of the previous page. URL-encode it: cursors are base64, and a raw + becomes a space.
expandstringRelated records to return inline instead of their URIs, comma-separated; dots reach nested relations, as in account_relations.account.
order-bystringFields to sort by, comma-separated. A leading - sorts descending, as in -modified; dotted paths sort by related fields.
filterobjectfilter[field]=value. Separate several values with a raw comma (OR), as in filter[name]=north,south. Encode a comma that belongs to a value as %2C. URLSearchParams and Python requests encode every comma, so build the filter part of the query string yourself. Dotted paths filter on related records, as in filter[owner.email]. Encode a + in a value as %2B: query values are form-decoded, so a raw + becomes a space.
filter-opobjectfilter-op[field]=operator, one per field: eq (the default), ieq, not-eq, not-ieq, contains, icontains, starts, istarts, ends, iends, gt, gte, lt, lte, between, null, not-null, empty and not-empty. null, not-null, empty and not-empty take no filter value; gt, gte, lt and lte take exactly one.
load-onlystringFields to return, comma-separated (raw or encoded commas both work here); dots select nested fields, as in owner.id. All fields are returned without it. Lists only: get-by-id refuses it with HTTP 400, code 118.

Responses

200 Page of Account records.: success, total, page_info, data 400 Bad request 401 Not authenticated 429 Rate limited 500 Server error

GET /entities/Accounts
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Accounts?first=10&filter%5Bname%5D=north&filter-op%5Bname%5D=icontains' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"
fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Accounts?first=10&filter%5Bname%5D=north&filter-op%5Bname%5D=icontains', {
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`)
  }
})
import os

import requests

response = requests.get(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Accounts",
    params={
      "first": "10",
      "filter[name]": "north",
      "filter-op[name]": "icontains"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"])
)

POST Create an account

Creates one account and answers 201 with the record. name and owner_id are required; relations are set by id (owner_id, unit_id, account_type_id).

Query parameters

NameTypeDescription
validation-levelintegerBit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

Request body

The new record's fields. Relations are set by id. Schema createAccountInput; the fields are in Account fields. Required: name, owner_id.

Responses

201 The created Account record.: success, data 400 Bad request 401 Not authenticated 422 Validation failed 429 Rate limited 500 Server error

POST /entities/Accounts
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Accounts' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Northwind Analytics",
  "owner_id": "37000000-0000-4000-a000-000000000001",
  "email1": "northwind@example.com",
  "phone1": "+1 555 0100",
  "city": "Seattle",
  "country": "United States"
}'
fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Accounts', {
  method: 'POST',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Northwind Analytics',
    owner_id: '37000000-0000-4000-a000-000000000001',
    email1: 'northwind@example.com',
    phone1: '+1 555 0100',
    city: 'Seattle',
    country: 'United States'
  })
})
import os

import requests

response = requests.post(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Accounts",
    headers={
      "Content-Type": "application/json"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
    json={
      "name": "Northwind Analytics",
      "owner_id": "37000000-0000-4000-a000-000000000001",
      "email1": "northwind@example.com",
      "phone1": "+1 555 0100",
      "city": "Seattle",
      "country": "United States"
    }
)

GET Get an account

Returns one account by id. expand returns related records inline instead of their URIs.

Path parameters

NameTypeDescription
idstring (uuid)Id of the Account record to retrieve. Required

Query parameters

NameTypeDescription
expandstringRelated records to return inline instead of their URIs, comma-separated; dots reach nested relations. The only parameter this call accepts.

Responses

200 The Account record.: success, data 400 Bad request 401 Not authenticated 404 Not found 429 Rate limited 500 Server error

GET /entities/Accounts/{id}
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Accounts/1d000000-0000-4000-a000-000000000001?expand=owner' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"
fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Accounts/1d000000-0000-4000-a000-000000000001?expand=owner', {
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`)
  }
})
import os

import requests

response = requests.get(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Accounts/1d000000-0000-4000-a000-000000000001",
    params={
      "expand": "owner"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"])
)

PATCH Update an account

Changes the fields you send and leaves the rest as they are; there is no PUT. An id in the body that differs from the one in the URL is refused with code 2002.

Path parameters

NameTypeDescription
idstring (uuid)Id of the Account record to update. Required

Query parameters

NameTypeDescription
validation-levelintegerBit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

Request body

The fields to change. Schema updateAccountInput; the fields are in Account fields.

Responses

200 The changed Account record.: success, data 400 Bad request 401 Not authenticated 404 Not found 422 Validation failed 429 Rate limited 500 Server error

PATCH /entities/Accounts/{id}
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Accounts/1d000000-0000-4000-a000-000000000001' \
  --request PATCH \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{
  "phone1": "+1 555 0199"
}'
fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Accounts/1d000000-0000-4000-a000-000000000001', {
  method: 'PATCH',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    phone1: '+1 555 0199'
  })
})
import os

import requests

response = requests.patch(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Accounts/1d000000-0000-4000-a000-000000000001",
    headers={
      "Content-Type": "application/json"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
    json={
      "phone1": "+1 555 0199"
    }
)

DEL Delete an account

Soft-deletes one account and answers with its id. A deleted account can be brought back with batch-restore.

Path parameters

NameTypeDescription
idstring (uuid)Id of the Account record to delete. Required

Responses

200 Deletion confirmation.: success, data 400 Bad request 401 Not authenticated 404 Not found 429 Rate limited 500 Server error

DEL /entities/Accounts/{id}
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Accounts/1d000000-0000-4000-a000-000000000001' \
  --request DELETE \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"
fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Accounts/1d000000-0000-4000-a000-000000000001', {
  method: 'DELETE',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`)
  }
})
import os

import requests

response = requests.delete(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Accounts/1d000000-0000-4000-a000-000000000001",
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"])
)

POST Create or update accounts in a batch

An item with an id updates that account; an item without one creates an account. By default one invalid item fails the whole call with HTTP 422 and nothing is written; with rollback-method=1 the valid items are written and the response has an id or an error for each item, in input order.

Query parameters

NameTypeDescription
validation-levelintegerBit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.
rollback-methodinteger0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item.

Request body

A JSON array of records: an item with an id updates, an item without one creates. Schema batchAccountInput; the fields are in Account fields. Required: name, owner_id.

Responses

200 Result per item, in request order: the id of the created or updated record, or the error.: success, data 400 Bad request 401 Not authenticated 422 Validation failed 429 Rate limited 500 Server error

POST /entities/Accounts/batch-modify
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Accounts/batch-modify' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "name": "Northwind account",
    "owner_id": "37000000-0000-4000-a000-000000000001"
  },
  {
    "id": "1d000000-0000-4000-a000-000000000001",
    "phone1": "+1 555 0199"
  }
]'
fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Accounts/batch-modify', {
  method: 'POST',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify([
    {
      name: 'Northwind account',
      owner_id: '37000000-0000-4000-a000-000000000001'
    },
    {
      id: '1d000000-0000-4000-a000-000000000001',
      phone1: '+1 555 0199'
    }
  ])
})
import os

import requests

response = requests.post(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Accounts/batch-modify",
    headers={
      "Content-Type": "application/json"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
    json=[
      {
        "name": "Northwind account",
        "owner_id": "37000000-0000-4000-a000-000000000001"
      },
      {
        "id": "1d000000-0000-4000-a000-000000000001",
        "phone1": "+1 555 0199"
      }
    ]
)

POST Delete accounts in a batch

Soft-deletes the accounts whose ids are in the body, a JSON array. By default an unknown id fails the whole call with HTTP 404.

Query parameters

NameTypeDescription
rollback-methodinteger0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item.

Request body

A JSON array of ids.

Responses

200 Result per id, in request order: the id of the deleted record, or the error.: success, data 400 Bad request 401 Not authenticated 404 Not found 422 Validation failed 429 Rate limited 500 Server error

POST /entities/Accounts/batch-delete
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Accounts/batch-delete' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '[
  "1d000000-0000-4000-a000-000000000001",
  "1d000000-0000-4000-a000-000000000002"
]'
fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Accounts/batch-delete', {
  method: 'POST',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(['1d000000-0000-4000-a000-000000000001', '1d000000-0000-4000-a000-000000000002'])
})
import os

import requests

response = requests.post(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Accounts/batch-delete",
    headers={
      "Content-Type": "application/json"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
    json=[
      "1d000000-0000-4000-a000-000000000001",
      "1d000000-0000-4000-a000-000000000002"
    ]
)

POST Restore deleted accounts

Restores the soft-deleted accounts whose ids are in the body, a JSON array.

Query parameters

NameTypeDescription
rollback-methodinteger0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item.

Request body

A JSON array of ids.

Responses

200 Result per id, in request order: the id of the restored record, or the error.: success, data 400 Bad request 401 Not authenticated 404 Not found 422 Validation failed 429 Rate limited 500 Server error

POST /entities/Accounts/batch-restore
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Accounts/batch-restore' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '[
  "1d000000-0000-4000-a000-000000000001",
  "1d000000-0000-4000-a000-000000000002"
]'
fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Accounts/batch-restore', {
  method: 'POST',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(['1d000000-0000-4000-a000-000000000001', '1d000000-0000-4000-a000-000000000002'])
})
import os

import requests

response = requests.post(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Accounts/batch-restore",
    headers={
      "Content-Type": "application/json"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
    json=[
      "1d000000-0000-4000-a000-000000000001",
      "1d000000-0000-4000-a000-000000000002"
    ]
)

POST Merge accounts

Merges duplicates into one account. master is the account to keep, with any field values to keep; the accounts in secondary_ids are merged into it and their relations move to it.

Request body

master, the record to keep with any field values to keep, and secondary_ids, the duplicates to merge into it. Schema batchAccountInput; the fields are in Account fields.

Responses

200 The merged master record.: success, data 400 Bad request 401 Not authenticated 422 Validation failed 429 Rate limited 500 Server error

POST /entities/Accounts/merge
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Accounts/merge' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{
  "master": {
    "id": "1d000000-0000-4000-a000-000000000001"
  },
  "secondary_ids": [
    "1d000000-0000-4000-a000-000000000002"
  ]
}'
fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Accounts/merge', {
  method: 'POST',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    master: {
      id: '1d000000-0000-4000-a000-000000000001'
    },
    secondary_ids: ['1d000000-0000-4000-a000-000000000002']
  })
})
import os

import requests

response = requests.post(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Accounts/merge",
    headers={
      "Content-Type": "application/json"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
    json={
      "master": {
        "id": "1d000000-0000-4000-a000-000000000001"
      },
      "secondary_ids": [
        "1d000000-0000-4000-a000-000000000002"
      ]
    }
)

Account fields

FieldTypeNotes
iduuidRead-only Unique identifier of entity.
namestringRequired on create Name of the entity and its default text representation.
owner_iduuid → ClientsRequired on create Id of the account owner.
createddate-timeCreation time.
pictureuri → CloudObjectsProfile picture or company logo associated with the account.
account_classintegerManual classification grade assigned to the account.1 NoClass · 2 ClassA · 3 ClassB · 4 ClassC · 5 ClassD
account_type_iduuid → AccountTypesId of the account type assigned to this account.
addressstringStreet address of the account.
citystringCity of the account address.
commentsstringFree-form notes describing the account.
countrystringCountry of the account address.
currency_exchange_rates_list_iduuid → CurrencyExchangeRatesListsId of the currency exchange rate list applied to this account.
customer_type_iduuid → DataId of the customer type (e.g.
email1stringPrimary email address of the account.
email2stringAdditional email address.
Show all 61 fields
FieldTypeNotes
email3stringAdditional email address.
email4stringAdditional email address.
email5stringAdditional email address.
home_pagestringWebsite URL of the account.
industry_iduuid → DataId of the industry classification.
is_archivedbooleanTrue when the account has been archived.
last_ai_account_hierarchy_applieddate-timeTime when an AI-suggested account hierarchy was last applied to this account.
last_ai_org_chart_applieddate-timeTime when an AI-suggested org chart was last applied to this account.
parent_account_iduuid → AccountsId of the parent account in the corporate hierarchy.
parent_account_relation_type_iduuid → ParentAccountRelationTypesId of the parent-account relationship type.
phone1stringPrimary phone number of the account.
phone2stringAdditional phone number.
phone3stringAdditional phone number.
phone4stringAdditional phone number.
phone5stringAdditional phone number.
picture_iduuid → CloudObjectsId of the profile picture document.
quick_parent_account_namestringFree-text parent-account name used when the parent has not been linked to an actual Account record.
share_modeintegerSharing model applied on top of the owner/unit visibility (e.g.0 Standard · 1 Private · 2 AllView · 3 AllEdit
state_provincestringState or province of the account address.
unit_iduuid → SalesUnitsId of the sales unit.
zip_codestringZIP or postal code of the account address.
revisionintegerRevision when entity was lastly changed.
social_mediauri → AccountSocialRelationsSocial network profiles linked to this account (e.g.
sharing_unitsarray of uri → AccountSharingSalesUnitRelationsSales units that have been granted shared access to this account.
sharing_clientsarray of uri → AccountSharingClientRelationsUsers that have been granted shared access to this account.
documentsarray of uri → CloudObjectRelationsDocuments linked to this account.
is_unsubscribedbooleanIf account has any unsubscribed email.
tagsarray of uri → TagRelationsTag labels applied to this account.
static_profilesarray of uri → ProfileRelationsSaved view profiles this account currently matches.
is_delete_protectedbooleanRead-only True when the record is protected against deletion because it must always exist in the space.
is_deletedbooleanRead-only Specifies if the entity is considered deleted.
modifieddate-timeRead-only Last modification time.
account_typeuri → AccountTypesRead-only Account type that classifies this account.
currency_exchange_rates_listuri → CurrencyExchangeRatesListsRead-only Currency exchange rate list used to convert monetary fields linked to this account.
customer_typeuri → DataRead-only Customer category (e.g.
industryuri → DataRead-only Industry the account operates in.
owneruri → ClientsRead-only Sales user who owns this account.
parent_accounturi → AccountsRead-only Parent account in a corporate hierarchy.
parent_account_relation_typeuri → ParentAccountRelationTypesRead-only Type of relationship to the parent account (e.g.
unituri → SalesUnitsRead-only Sales unit this account is assigned to.
health_categoryuuidRead-only Coarser bucket of health_status used for grouping and reporting.
health_statusintegerRead-only Computed entity-health state (e.g.
formatted_namestringRead-only Display version of the account name, used in lists and references.
is_favoritebooleanRead-only True when the current authenticated user has marked this account as favorite.
healthobjectRead-only Composite entity-health summary, combining current and previous state with last-calculation metadata.
modified_by_userdate-timeRead-only Timestamp of the most recent modification made by an end user (excluding system changes).

Custom fields appear in your space's live spec: fetch it with your credentials.

Errors

Every error body has success: false, http_status, code, name and message. Branch on code: the status alone does not tell a missing permission from a bad parameter. All codes: error codes; how to handle them: Errors.

HTTPWhen
400Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check code.
401Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED).
404No such record or entity (code 143 ERROR_NO_ENTITY, or 2006 ERROR_UNKNOWN_TYPE).
422Validation failed (code 40000, with the failing fields) or a required parameter is missing (code 119). By default one failed item fails a whole batch and nothing is written.
429Too many requests (code 182). Wait for the seconds in Retry-After, then retry.
500Unexpected server error (code 1000, ERROR_UNKNOWN).

Webhook events for accounts

Account.Create Account.Delete Account.DocumentLinked Account.OwnerChanged Account.Update See payloads

Subscribe with Create a webhook.