Create a Record

In the record list

📘

Supported Regions and Base URLs

👍

Access and Registration

Authentication

Scope

record-lists:manage

Body Request - Example

{
  "phone_numbers": [
    {
      "phone_number": "+351929312312",
      "phone_type": "MOBILE"
    },
    {
      "phone_number": "+351929312300",
      "phone_type": "OFFICE"
    },
    {
      "phone_number": "+351929312301",
      "phone_type": "HOME"
    }
  ],
  "first_name": "Joey",
  "last_name": "Tribbiani",
  "timezone": "Europe/Lisbon",
  "priority": 6,
  "external_provider": "salesforce",
  "external_id": "0030O000024ukNtQAD",
  "external_url": "https://xxx.salesforce.com/0030O000024ukNtQAD",
  "sync_external_id": true,
  "extra_data": {
    "country": "USA",
    "state": "California",
    "job": "Actor"
  }
}

phone_numbers Body Parameter

ParameterTypeDescriptionRequired
phone_numberstringRecord phone number
>= 1 characters
<= 20 characters
yes
phone_typestringThe type of the phone number
>= 4 characters
<= 7 characters
Allowed values: "HOME",
"OFFICE", "MOBILE",
"EXTRA_1", "EXTRA_2",
"EXTRA_3"
yes

Body Response - Schema

201 (record created)

ParameterTypeDescriptionRequired
idstringrecord IDno
record_list_idstringrecord list IDno
phone_numberstringphone number of the record (required if phone_numbers field is not present)deprecated
phone_numbersarray[object]List of phone numbers of the record (required if phone_number field is not present). >= 1 items

"phone_numbers" subdivides into:

1 - "phone_number" (string) - record phone number.
>= 1 characters
<= 20 characters. Required.

2 - "phone_type" (string) - The type of the phone number.
>= 4 characters
<= 7 characters
Allowed values: "HOME",
"OFFICE", "MOBILE",
"EXTRA_1", "EXTRA_2",
"EXTRA_3". Required.
first_namestringFirst name of the record. Mandatory field.
>= 1 characters
<= 80 characters
no
last_namestringLast name of the record. Mandatory field.
>= 1 characters
<= 80 characters
no
timezonestringTimezone of the record.
>= 1 characters
<= 35 characters
no
priorityintegerPriority of the record within the record list. >= 1 <= 10no
extra_dataobjectextra data of the recordno
external_providerstringreference for external provider sourceno
external_idstringunique identifier for resource in external sourceno
external_urlstringresource location in external sourceno
sync_external_idbooleansync external ID with contactsno
created_atstringrecord creation dateno
updated_atstringrecord udpate dateno
_linksobject"_links" subdivides into:

1 - "self" (object)
1.1 - "href" (string)
no

400 (errors found in the submitted data), 401 (unauthorized), 403 (forbidden), 404 (record list not found)

ParameterTypeDescriptionRequired
codestringn/ayes
messagestringn/ayes
descriptionstringn/ano
fieldsarray[object]"fields" subdivides into:

"name" (string)

"description" (string)
yes (name and description)

🚧

Troubleshooting

If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.

Language
Authorization
Header
Click Try It! to start a request and see the response here!