Skip to content
API Reference
/
/
Create Job For A Payload...

Create Job For A Payload PDF Workflow

Request

Create a Job for a workflow based on a PDF payload. It stores the provided payload and returns the url where to upload the PDF file to be processed. Note that the Job will be in AWAITING_FOR_FILE status for maximum 2 hours and will be deleted if no file is provided.

Security
api_key
Headers
x-managed-company-idstring

Optional: the ID of the managed company on behalf of which the request is made

Bodyapplication/jsonrequired
workflowIdstringrequired

Unique identifier of the Workflow to which the Job will be associated

jobNamestringrequired

Name of the Job to be created

filenamestringrequired

Name of the the file that will be used for the Job

sendingEventExecutionDateUtcstring, (date-time)

Datetime of the scheduled SendingEvents execution in UTC

payloadobject(PayloadDto)required

Payload content used to build the sending event

curl -i -X POST \
  https://doc.acc.connect.easypost.eu/_mock/public-api/openapi/jobs/payload-pdf \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-managed-company-id: string' \
  -d '{
    "workflowId": "string",
    "jobName": "string",
    "filename": "string",
    "sendingEventExecutionDateUtc": "2019-08-24T14:15:22Z",
    "payload": {
      "channelIdentifiers": [
        {
          "kind": "ADDRESS",
          "value": "string",
          "mustBeEncrypted": true
        }
      ],
      "extraInfoIdentifiers": [
        {
          "name": "string",
          "value": "string",
          "mustBeEncrypted": true
        }
      ]
    }
  }'

Responses

Bodyapplication/json
idstringrequired

Unique identifier of the created Job

fileUploadUrlstringrequired

Presigned URL to be used to upload the file of the Job and start effectively its processing. The upload is made via an HTTP PUT request with the file attached as binary to the request.

Response
{
  "id": "string",
  "fileUploadUrl": "string"
}