Update Record Lists

Returns a record list object and starts file validation.

📘

Supported Regions and Base URLs

👍

Access and Registration

Authentication

Scope

record-lists:write

Body Response - Schema

200 (updated record list)

ParameterTypeDescriptionRequired
idstring ID of the record list.no
namestringn/ano
unique_identifier_typestringDuplicate checking logic configured for the record list:

- PHONE_NUMBER - Duplicate checking based on the record's phone_number.
- EXTERNAL - Duplicate checking based on the record's external_id and external_provider.
- NOTHING - No duplicate checking.
no
created_atstringDate of record list creation.no
records_countintegerNumber of records in the record list.no
account_idstringAccount ID of record list.
statusstringStatus of the csv file associated with the record list.no
_linksobject"_links" subdivides into:

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

400 (errors found in the submitted request), 401 (unauthorized), 403 (forbidden), 404 (record list not found), 409 (request conflicts with current state of record list or upload request)

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!