Skip to main content
POST
/
contacts
cURL
curl --request POST \
  --url https://api.alpharun.com/api/v1/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "phone_number": "<string>",
  "ext_id": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "custom_fields": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ]
}
'
{
  "id": "<string>",
  "email": "[email protected]",
  "phone_number": "<string>",
  "ext_id": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "custom_fields": [
    {
      "key": "<string>",
      "value": "<string>",
      "type": "<string>",
      "display_name": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

At least one of email, phone number and ext id must be not null on the contact. Contacts are unique per email, phone number, or ext_id. No two contacts can have the same email, phone number, or ext_id.

​
email
string<email>
required

Email address of the contact

​
phone_number

Phone number of the contact

​
ext_id
string

Ext id of the contact

​
first_name
string

First name of the contact

​
last_name
string

Last name of the contact

​
custom_fields
object[]

Custom fields to populate on the contact

Response

Contact created successfully

​
id
string

ID of the contact

​
email
string<email>

Email address of the contact

​
phone_number
string

Phone number of the contact

​
ext_id
string

Ext id of the contact

​
first_name
string

First name of the contact

​
last_name
string

Last name of the contact

​
custom_fields
object[]

Custom fields of the contact