PATCH/PUT /api/v1/queues — Retry or Edit Queue Entries

Retry a failed queue entry by queue id, or by campaign_id plus audience_id or member_id. PUT updates the message text on a queued entry.

Use the queues endpoint to retry failed campaign actions or update the message text on a queued entry before it runs. Retry by queue ID for precision, or by campaign and audience identifiers when the queue ID is unknown.

Retry by Queue ID

Retry a specific queue entry using its unique ID.

Endpoint

PATCH /api/v1/queues

Parameters

id · integer · required

The queue entry ID to retry.

retry · boolean · required

Must be true to trigger a retry.

Request Example

curl -X PATCH 'https://reachowl.com/api/v1/queues' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"id": 99, "retry": true}'

---

Retry by Audience and Step

Retry a queue entry by campaign ID and audience identifier.

Endpoint

PATCH /api/v1/queues

Parameters

campaign_id · integer · required

The campaign ID the queued action belongs to.

audience_id · integer

The audience ID of the queued action. Provide audience_id or member_id.

member_id · string

The member ID of the queued action. Provide audience_id or member_id.

step · integer · required

The campaign step number to retry.

retry · boolean · required

Must be true to trigger a retry.

Request Example

curl -X PATCH 'https://reachowl.com/api/v1/queues' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"campaign_id": 1, "audience_id": 42, "step": 1, "retry": true}'

---

Update Message on Queue Entry

Change the message text on a queued entry before it is processed.

Endpoint

PUT /api/v1/queues

Parameters

id · integer · required

The queue entry ID to update.

message · string · required

The new message text for the queued action.

Request Example

curl -X PUT 'https://reachowl.com/api/v1/queues' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"id": 99, "message": "Updated message text"}'

Response Examples

Retry Response

{
  "message": "Queue entry retried successfully"
}

Update Response

{
  "id": 99,
  "message": "Updated message text",
  "updated_at": "2024-01-20T14:00:00Z"
}

Error Responses

Status	Description
401	Unauthorized
404	Queue entry not found
422	Validation error - Missing required parameters