Sequences

Get a sequence enrollment realignment job

Changed on

Returns the state of an applied realignment job. When status is completed, result contains the bounded realignment result and any continuation cursor.

get/sequences/{sequenceId}/enrollments/realign-sending-window/jobs/{jobId}

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/sequences/{sequenceId}/enrollments/realign-sending-window/jobs/{jobId}
  • Auth
    HTTP bearer

Path parameters

sequenceIdstring required
jobIdstring required

Response

Job status

successboolean required
sequenceIdstring required
sequenceNamestring
dryRunfalse required
status'queued' | 'running' | 'completed' | 'failed' required
jobIdstring required
resultobject nullable required

Completed realignment result; null while queued, running, or failed.

errorstring nullable required
messagestring required

Example response

{
  "success": true,
  "sequenceId": "seq_abc123",
  "sequenceName": "52-Week Medicine Wheel"
}

Changes

  • db3873ca3d4dRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • ba3a29c6eb33Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status