Signed URL

📘
Supported Regions and Base URLs

Scope

record-lists:manage

Request Body (required)

{
  "csv_metadata": {
    "filename": "recordList.csv",
    "byte_size": 413,
    "checksum": "d2c07dcf1589304317056dd7e28e32b8",
    "content_type": "text/csv"
  },
  "callback_action": {
    "endpoint": "http://endpoint/callback",
    "method": "POST",
    "body": {
      "address": "old street"
    },
    "headers": {
      "x-api-key": "secret key"
    }
  },
  "send_atlas_notification": true
}

csv_metadata Body Parameter

Parameter	Type	Description	Required
filename	string	Name of the csv file to be uploaded. >= 1 characters <= 35 characters	no
byte_size	integer	Size of the file in bytes. >= 1 <= 20000	no
checksum	string	Hash of the file done using the algorithm MD5. >= 1 characters <= 32 characters	no
content_type	string	text/csv. >= 1 characters <= 35 characters	no

callback_action Body Parameter

Parameter	Type	Description	Required
endpoints	string	the endpoint for the callback request	yes
method	string	method to call the callback request	yes
body	object	body of the callback request	no
headers	object	headers used in the callback request	no

Body Response - Schema

201 (created signed URL for the csv file)

Parameter	Type	Description	Required
id	string	ID of upload request	no
record_list_id	string	ID of record list	no
signed_url	string	URL to save the csv file in S3	no
status	string	current status of the upload request	no
_links	object	"_links" subdivides into: 1 - "self" (object) 1.1 - "href" (string) 2 - "record_list" (object) 2.1 - "href" (string) 3 - "upload" (object) 3.1 - "href" (string)	no

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

Parameter	Type	Description	Required
code	string	n/a	yes
message	string	n/a	yes
description	string	n/a	yes
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.

📘

Scope

Request Body (required)

csv_metadata Body Parameter

callback_action Body Parameter

Body Response - Schema

201 (created signed URL for the csv file)

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

🚧Troubleshooting

🚧
Troubleshooting