Upload Request Object

Return an upload request object and starts file validation. It notifies by Webhook or Workspace notification when it is finished, if previously set to do so

📘

Supported Regions and Base URLs

👍

Access and Registration

Authentication

Scope

record-lists:manage

Request Body (required)

{
  "op": "replace",
  "path": "/status",
  "status": "UPLOADED"
}

Body Response - Schema

200 (upload request updated)

ParameterTypeDescriptionRequired
idstringID of upload requestno
record_list_idstringID of record listno
statusstringcurrent status of upload requestno
_linksobject"_links" subdivides into:

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

2 - "record_list" (object)
2.1 - "href" (string)
no

400 (errors found in the submitted request), 401 (unauthorized), 403 (forbidden), 404 (resource 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!