KUkudosity
Senders

Delete a sender by phone number

Changed on

Deletes a sender phone number from the account.

  • If you omit child_account_id, the API deletes the sender from the authenticated account.
  • If you provide child_account_id, the API deletes the sender from that account: your own account or one of your child accounts. The API returns 404 Not Found for an account that isn't visible to you, and 403 Forbidden for one that's visible but you don't manage. Before these responses were added, an account you couldn't use returned 400 Bad Request.
delete/v2/senders/phone-numbers/{phone_number}

Request

  • Base URL
    https://api.transmitmessage.com
  • Auth
    API key in header x-api-key

Path parameters

phone_numberstring required

The phone number to delete in E.164 international format, for example 61412312312.

Query parameters

child_account_idstring

The account to delete the sender from, your own account or one of your child accounts. If omitted, the API deletes the sender from the authenticated account.

Response

Sender deleted successfully. No content is returned.

Changes

  • e6206dcd3439Revision changes
    • breaking

      added to the response body oneOf list for the response status

    • breaking

      the response's body type changed from object to no type for status

    • breaking

      removed the required property from the response with the status

    • info

      added the non-success response with the status

  • e7314f92947aRevision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the required property to the response with the status