post https://api.talkdeskapp.com/record-lists//records
In the record list
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
| Parameter | Type | Description | Required |
|---|---|---|---|
| phone_number | string | Record phone number > = 1 characters > <= 20 characters | yes |
| phone_type | string | The 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)
| Parameter | Type | Description | Required |
|---|---|---|---|
| id | string | record ID | no |
| record_list_id | string | record list ID | no |
| phone_number | string | phone number of the record (required if phone_numbers field is not present) | deprecated |
| phone_numbers | array[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_name | string | First name of the record. Mandatory field. > = 1 characters > <= 80 characters | no |
| last_name | string | Last name of the record. Mandatory field. > = 1 characters > <= 80 characters | no |
| timezone | string | Timezone of the record. > = 1 characters > <= 35 characters | no |
| priority | integer | Priority of the record within the record list. >= 1 <= 10 For hot leads, exclude the field or keep the priority value as “null”. Note: Empty string on priority will return an error. | no |
| extra_data | object | extra data of the record | no |
| external_provider | string | reference for external provider source | no |
| external_id | string | unique identifier for resource in external source | no |
| external_url | string | resource location in external source | no |
| sync_external_id | boolean | sync external ID with contacts | no |
| created_at | string | record creation date | no |
| updated_at | string | record udpate date | no |
| _links | object | "_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)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields | array[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.