Skip to main content
POST
Run a Job

Authorizations

x-deck-client-id
string
header
required

Enter your client id

x-deck-secret
string
header
required

Enter your secret

Headers

x-deck-correlation-id
string<uuid>
x-deck-sandbox
string

Enterprise only. Can be used against the sandbox API with special values to test error use cases.

Body

application/json
job_code
string
required

The job type identifier

Example:

"FetchDocuments"

input
object
required

Dynamic input object - structure varies by job type

Example:

Response

Accepted

job_guid
string<uuid>
job_code
string