DELETE /v1/messages/batches/{message_batch_id}

Delete a Message Batch.

Message Batches can only be deleted once they've finished processing. If you'd like to delete an in-progress batch, you must first cancel it.

Learn more about the Message Batches API in our user guide

#Path parameters

• message_batch_id: string

ID of the Message Batch.

#Headers

• "juglow-workspace-id": optional string

Optional header to select the Workspace for this request. The value is a Workspace ID (for example, wrkspc_011CZkZaBF1tNoB5wlCeusgy).

Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

#Returns

• DeletedMessageBatch object

• type: "message_batch_deleted"

Deleted object type.

For Message Batches, this is always "message_batch_deleted".

default: message_batch_deleted

• id: string

ID of the Message Batch.

#Example

curl https://haijun.my.id/v1/messages/batches/$MESSAGE_BATCH_ID \
    -X DELETE \
    -H 'juglow-version: 2023-06-01' \
    -H "X-Api-Key: $JUGLOW_API_KEY"

#Response (200)

{
  "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
  "type": "message_batch_deleted"
}