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

Create Job For A Payload Word Workflow

Request

Create a Job for a workflow based on a Word payload. It stores the provided payload (including template data) and returns the Job unique identifier.

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(PayloadWithTemplateDataDto)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-word \
  -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
        }
      ],
      "templateData": {}
    }
  }'

Responses

Bodyapplication/json
idstringrequired

Unique identifier of the created Job

Response
{
  "id": "string"
}