POST
/
v2
/
contact
Create Contact
curl --request POST \
  --url https://api.sonderplan.com/v2/contact \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Sam Smith",
  "type": "person",
  "linked_organization_id": 137834,
  "client": true,
  "email_1": "[email protected]",
  "email_2": "[email protected]",
  "email_3": "",
  "phone_1": "+1-541-754-3010",
  "phone_2": "",
  "phone_3": "",
  "address_line_1": "Unit 1/43",
  "address_line_2": "123 Example Street",
  "address_line_3": "",
  "address_city": "Surry Hills",
  "address_state": "NSW",
  "address_postcode": "2010",
  "address_country": "Australia",
  "website": "www.example.com",
  "icon": {},
  "custom_fields": [
    {
      "id": 7823,
      "name": "Type",
      "value": "Video Editing",
      "value_id": 8973,
      "update_key": "2_1_7823"
    }
  ]
}'
{
  "success": {
    "id": 1
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Contact object that needs to be added

The default contact schema

​
name
string
required

Full name of the contact

Example:

"Sam Smith"

​
type
enum<string>
required

Type of the contact

Available options:
person,
organization
Example:

"person"

​
linked_organization_id
integer

The organization id that this contact has been added to. Applies only for 'person' type contacts.

Example:

137834

​
client
boolean

If true, the contact will be selectable in client menus

Example:

true

​
email_1
string

Primary email address of the contact

Example:

"[email protected]"

​
email_2
string

Secondary email address of the contact

Example:

"[email protected]"

​
email_3
string

Tertiary email address of the contact

Example:

""

​
phone_1
string

Primary phone number of the contact

Example:

"+1-541-754-3010"

​
phone_2
string

Secondary phone number of the contact

Example:

""

​
phone_3
string

Tertiary phone number of the contact

Example:

""

​
address_line_1
string

Contacts address first line

Example:

"Unit 1/43"

​
address_line_2
string

Contacts address second line

Example:

"123 Example Street"

​
address_line_3
string

Contacts address third line

Example:

""

​
address_city
string

Contacts city

Example:

"Surry Hills"

​
address_state
string

Contacts state

Example:

"NSW"

​
address_postcode
string

Contacts state

Example:

"2010"

​
address_country
string

Contacts country

Example:

"Australia"

​
website
string

Website of the contact

Example:

"www.example.com"

​
icon
object

Icon / avatar of the contact

​
custom_fields
Custom Field Module Value · object[]

Response

Successful Operation

​
success
object