Accounts

Accounts represent companies or organizations. They support full CRUD, query, _assert, relationships, and domain sub-resources.

Supported actions

Action	Endpoint
Create	`POST /api/v2/account`
Read	`GET /api/v2/account/{account_id}`
Query	`POST /api/v2/account/_query`
Update	`PATCH /api/v2/account/{account_id}`
Archive	`DELETE /api/v2/account/{account_id}`
Create or update	`POST /api/v2/account/_assert`
Relationships	`/api/v2/account/{account_id}/relationship/{api_name}`
Domains	`/api/v2/account/{account_id}/attribute/domains`

Common fields

Field	Value type	Notes
`display_name`	`string`	Account name
`domains`	`account_domain[]`	Managed through the domains sub-resource
`description`	`long_text`	Writable
`current_stage_id`	`account_stage`	Account lifecycle stage
`owner_user_id`	`record_reference`	Owner user reference
`created_at`, `updated_at`	`timestamp`	System fields

Use GET /api/v2/_schema/account for the complete field list in your workspace. Use domain_name as the _assert match key and inside /attribute/domains requests, not as a direct account attributes field.

Create-or-update by domain

{
  "match": {
    "domain_name": "acme.com"
  },
  "attributes": {
    "display_name": "Acme",
    "current_stage_id": "target_account",
    "description": "Enterprise software company"
  }
}

Contacts relationship

Accounts expose typed contact relationship routes.

GET  /api/v2/account/{account_id}/relationship/contacts
POST /api/v2/account/{account_id}/relationship/contacts

Domains

Use domain sub-resource endpoints when you need to add, remove, or set a primary domain.

{
  "domain_name": "acme.com"
}

Only domains is routed as an account attribute sub-resource today. To promote a domain to primary, patch /api/v2/account/{account_id}/attribute/domains/{domain_name} with {"is_primary": true}.

Common errors

Error code	Usually means
`ambiguous_match`	`_assert` or `related_record_match` found more than one account
`unknown_field`	Field is not in account schema
`field_not_updatable`	Request tried to write a computed or system field
`target_record_not_found`	Relationship target did not resolve

Contacts Opportunities

⌘I

​Accounts

​Supported actions

​Common fields

​Create-or-update by domain

​Contacts relationship

​Domains

​Common errors