POST
/v1/api/jobsDeclare a job's files
Scope processing. Answers one upload URL per file; nothing is processed until you start the job.
Send request
Use the documented inputs to call this endpoint directly.
API serverbase URL
Bearer tokenkeyoptional
Stored only in this browser for the key security scheme and reused on every API page in this group.
Request body
application/jsonrequiredfilesarray<>required
cellsobjectoptional
Values for the deal's own columns, as strings, keyed by column label or id.
Responses
201application/json
Declared.
{
"data": {
"id": "",
"state": "awaiting_start",
"files": [
{
"id": "",
"name": "string",
"contentType": "string",
"sizeBytes": 1,
"documentType": "string",
"uploadUrl": "string"
}
]
}
}dataoptional
400application/json
The files are wrong — the message names the rule.
{
"error": {
"message": "string"
}
}errorrequired
401application/json
No key, or an unknown or revoked one.
{
"error": {
"message": "string"
}
}errorrequired
402application/json
A key issued from Settings → Developer, on a workspace without the Enterprise plan.
{
"error": {
"message": "string"
}
}errorrequired
403application/json
The key was not given processing, or is a board key.
{
"error": {
"message": "string"
}
}errorrequired
404application/json
No job or deal with that id that this key can reach.
{
"error": {
"message": "string"
}
}errorrequired
503application/json
File storage is not configured.
{
"error": {
"message": "string"
}
}errorrequired