patch https://api.talkdeskapp.com/record-lists//records/
Inside a record list
Scope
record-lists:manage
Request Body (required)
[
{
"op": "replace",
"path": "/priority",
"value": 6
},
{
"op": "add",
"path": "/extra_data/home",
"value": "USA"
},
{
"op": "replace",
"path": "/extra_data/name",
"value": "Jerry"
}
]
Body Schema - Response
200 (record updated)
| 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 the phone_numbers field is not present) | deprecated |
| phone_numbers | array[object] | List of phone numbers of the record (required if the phone_numbers 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. | yes |
| first_name | string | First name of the record. >= 1 characters <= 80 characters | yes |
| last_name | string | Last name of the record. >= 1 characters <= 80 characters | yes |
| timezone | string | Timezone of the record. >= 1 characters <= 35 characters | no |
| priority | integer | Priority of the record within the record list. >= 1 <= 10 | 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). Required. | no |
400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (record list not found), 422 (unprocessable record)
| 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.
Body Response
The parameters from the body response are part of an array.