Skip to main content
DELETE
/
api
/
v1
/
outbound
/
batches
/
{batch_id}
Python (SDK)
import os
from syllable_sdk import SyllableSDK


with SyllableSDK(
    api_key_header=os.getenv("SYLLABLESDK_API_KEY_HEADER", ""),
) as ss_client:

    res = ss_client.outbound.batches.delete(batch_id="<id>", body_outbound_batch_delete={
        "delete_reason": "<value>",
    })

    # Handle response
    print(res)
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Syllable-API-Key
string
header
required

Path Parameters

batch_id
string
required

Body

application/x-www-form-urlencoded
delete_reason
string
required

Response

Successful Response