Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

API Key authentication with required prefix "Bearer"

Body

Maximum string length: 255
external_id
string
required
Maximum string length: 255
trade_name
string | null
Maximum string length: 255
phone_number
string | null
Maximum string length: 10
email
string | null
Maximum string length: 255
federal_ein
string | null
Maximum string length: 255
address
object | null
user_assignments
string[]
metadata
object

Up to 50 key-value pairs. Keys max 40 characters, values max 500 characters. Set a value to empty string to remove a key. On PATCH, metadata is merged with existing values.

Response

201 - application/json
id
string
required
read-only
Pattern: ^[-a-zA-Z0-9_]+$
Maximum string length: 255
external_id
string
required
Maximum string length: 255
created_at
string<date-time>
required
read-only
trade_name
string | null
Maximum string length: 255
phone_number
string | null
Maximum string length: 10
email
string | null
Maximum string length: 255
federal_ein
string | null
Maximum string length: 255
address
object | null
status
enum<string>
  • not_started - Not Started
  • pending - Pending
  • processing - Processing
  • needs_attention - Needs Attention
  • review - Review
  • completed - Completed
  • inactive - Inactive
Available options:
not_started,
pending,
processing,
needs_attention,
review,
completed,
inactive
primary_business_unit
string
read-only
user_assignments
string[]
metadata
object

Up to 50 key-value pairs. Keys max 40 characters, values max 500 characters. Set a value to empty string to remove a key. On PATCH, metadata is merged with existing values.