Skip to main content
POST
Create a contact

Authorizations

Authorization
string
header
required

An API key created in BeanRails, for example brk_live_....

Body

application/json

At least one of company_name, first_name, last_name, email or phone is required.

company_name
string
Maximum string length: 255
first_name
string
Maximum string length: 255
last_name
string
Maximum string length: 255
email
string<email>
phone
string
Maximum string length: 255
contact_number
string

Required only when the workspace does not number contacts automatically.

status
string

A contact status value defined in the workspace.

user_id
integer

The user to assign the contact to. Defaults to the key owner.

groups
integer[]

Contact group IDs.

discounts
integer[]
addresses
object[]

Response

The created contact.

data
object