Skip to main content
POST
/
v1
/
jobs
Create Job
curl --request POST \
  --url {protocol}://{host}{basePath}/v1/jobs \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "data": {
    "workflow": 123,
    "validUntil": 123,
    "language": "<string>",
    "customer": {
      "name": "<string>",
      "mobile": "<string>",
      "email": "<string>",
      "customerID": "<string>"
    },
    "externalRefNumber": "<string>",
    "metadata": "<string>",
    "input": [
      {
        "key": "<string>",
        "value": "<string>",
        "type": "<string>",
        "description": "<string>"
      }
    ]
  }
}
'
{
  "success": true,
  "data": {
    "jobId": "<string>",
    "status": "<string>",
    "workflow": {
      "id": 123,
      "name": "<string>"
    },
    "customer": {
      "name": "<string>",
      "mobile": "<string>",
      "email": "<string>",
      "customerID": "<string>"
    },
    "externalRefNumber": "<string>",
    "createdAt": "<string>",
    "validUntil": "<string>",
    "accessUrl": "<string>"
  }
}

Authorizations

x-api-key
string
header
required

Body

application/json
data
object
required

Response

Job created successfully.

success
boolean
data
object