Post V2 Promotions Promotionid Jobs Jobid Cancel

Cancel a Job

POST/v2/promotions/{promotionID}/jobs/{jobID}/cancel

Use it in a workflow

Add a step and choose the Elastic Path connector.
Pick the Post V2 Promotions Promotionid Jobs Jobid Cancel action (under Promotions).
Fill in the fields below, then reference the result from later steps as {{postV2PromotionsPromotionidJobsJobidCancel.response.data}}.

Request

Path parameters

promotionIDstringrequired

The unique identifier of a promotion.

jobIDstringrequired

The unique identifier of a job to be canceled.

Headers

Authorizationstring (Bearer)required

The Bearer token required to get access to the API.

Response

Returns 200 with an object. Read it in later steps with {{postV2PromotionsPromotionidJobsJobidCancel.response.data.<field>}}.

dataobject

idstring

A unique ID generated when a job is created.

typestring

Always `promotion_job`.

promotion_idstring

A unique ID of a promotion.

job_typestring

The type of job you want to run. For example, `code_generate` to generate codes or `code_export` to export codes.

namestring

The name of the job. The maximum length allowed is 50 characters.

parametersobject

statusstring

The status of the job. See [Overview](/docs/api/promotions/promotion-jobs).

metaobject1 fields

json

{
  "data": {
    "id": "string",
    "type": "promotion_job",
    "promotion_id": "string",
    "job_type": "string",
    "name": "string",
    "parameters": {},
    "status": "string",
    "meta": {
      "timestamps": {
        "created_at": "2025-01-01T00:00:00Z",
        "updated_at": "2025-01-01T00:00:00Z"
      }
    }
  }
}

Need more? See the Elastic Path guide for connection setup and behaviour shared by every action.

Was this page helpful?