Skip to main content
POST
/
contacts
Create a new Contact
curl --request POST \
  --url https://commerce.driv.ly/api/contacts \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "cnt_8dk3j2ksl9d2",
  "roles": [
    "Manager",
    "Sales"
  ],
  "lastName": "Smith",
  "firstName": "Alice"
}'
{
  "data": {
    "id": "cnt_8dk3j2ksl9d2",
    "roles": [
      "Manager",
      "Sales"
    ],
    "lastName": "Smith",
    "firstName": "Alice"
  },
  "success": true
}

Query Parameters

​
depth
integer

The number of levels of related objects to include in the response

Body

application/json
​
lastName
string
required

Contact has Last Name

​
firstName
string
required

Contact has First Name

​
id
string

Contact is uniquely identified by id

​
agent

Contact is automated Agent

​
address

Contact has Address

​
primaryPhoneNumber
string

Contact has Primary Phone Number

​
primaryEmail
string<idn-email>

Contact has Primary Email

​
emails
string<idn-email>[]

Contact has Email

​
phoneNumbers
string[]

Contact has Phone Number

​
roles
string[]

Contact has Role

Response

Contact Created

​
data
object
Examples:
{
  "id": "cnt_8dk3j2ksl9d2",
  "roles": ["Manager", "Sales"],
  "lastName": "Smith",
  "firstName": "Alice"
}
​
success
boolean
⌘I