Update job status

PUT

/api/nova/jobs/{jobId}/status

Changes the status of a job identified by the jobId path variable. The request body must include statusId, which is resolved against the account's job status master data before the change is applied; optional reasonId and comments can be supplied to record why the status changed. Returns the job ID with the message Status updated on success. Returns 400 if statusId is blank, 404 if the job or the status is not found, 429 if rate limited, 401 for an invalid API key, and 500 with an error message on failure.

Authorizations

privateApiKey

Type

API Key (query: apiKey)

Parameters

Path Parameters

jobId*

jobId

Type

string

Required

Query Parameters

apiKey*

apiKey

Type

string

Required

Request Body

application/json

{

  

"comments": "string",

  

"reasonId": "string",

  

"statusId": "string"

}

Responses

OK

Content-Type

application/json

{

  

"data": "string",

  

"error": "string",

  

"message": "string",

  

"requestId": "string",

  

"success": true

}

PUT

/api/nova/jobs/{jobId}/status

Playground

Authorization

privateApiKey

Variables

Key

Value

jobId*

apiKey*

Body

Samples