Skip to content

Retrieve a bulk promo code definition status update job

Request

Tracks the progress of your promo code status update job.

When your job completes, the status will display as done and you will see any issues that display with individual codes so you know exactly what needs attention.

Security
ZephrHmacHttp
Path
jobIdstring, (uuid)required

A unique job ID, that identifies your specific update job.

cURL
curl -i -X GET \
  'https://demo.api.zephr.com/zephr/integration/promo-codes/v1/definitions/status-update-jobs/{jobId}' \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>'

Responses

OK. Displays the job status and how many items succeeded or failed.

Headers
any
Bodyapplication/json
jobIdstring, (uuid)required

The unique ID assigned to your bulk status-update job.

statusstringrequired

The current status of your job.

Enum:"ready""processing""done"
Example:"done"
jobDatestringrequired

When the job was created or last updated.

succeededintegerrequired

The number of successful status updates.

errorsintegerrequired

The number of failed status updates.

totalintegerrequired

The total number of definitions in the job.

detailsArray of objects(promo-code-definition-status-update-job-detail)required

Failure details for each definition that had issues (empty if all succeeded).

Response
{ "jobId": "7b07e5e2-8eb8-4c10-a85f-529c0b3385b6", "status": "done", "jobDate": "2026-09-25T10:15:30Z", "succeeded": 1, "errors": 1, "total": 2, "details": [ { … } ] }