Create a Record List

And signed URL for the CSV file

📘

Supported Regions and Base URLs

👍

Access and Registration

Authentication

Scope

record-lists:manage

Request Body (required)

{
  "name": "RecordList 20",
  "csv_metadata": {
    "filename": "recordList.csv",
    "byte_size": 413,
    "checksum": "d2c07dcf1589304317056dd7e28e32b8",
    "content_type": "text/csv"
  }
}

Body Response - Schema

201 (created record list and signed URL for the csv file

ParameterTypeDescriptionRequired
idstringID of the csv fileno
namestringname of the csv file to be uploadedno
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
statusstringstatus of the csv fileno
signed_urlstringURL to save the csv file in S3no
_linksobject"_links" subdivides into:

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

400 (errors were found in the submitted data), 401 (unauthorized), 403 (forbidden), 413 (payload too large)

ParameterTypeDescriptionRequired
codestringn/ano
messagestringn/ano
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!