Remove a sender

Disconnect the account at the provider, then delete it. A mailbox bought for it is cancelled and the connected-account add-on follows the count down. If the provider does not confirm at once, the account is removed there in the background.

DELETEhttps://app.trygtm.com/api/v1/senders/{sender_id}
Scope
write

Path parameters

sender_idstringrequired
The sender's id, from list_senders.

Headers

Idempotency-Keystringoptional
A key unique to this write, up to 255 characters. A retry carrying the same key returns the first response instead of running again. Kept for 24 hours.

Request

curl -X DELETE https://app.trygtm.com/api/v1/senders/8f2a91c4-6d1e-4c0a-9a57-2f3b1c7e9d10 \
  -H "Authorization: Bearer $TRYGTM_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

Response

{
  "data": {
    "sender_id": "d4c3b2a1-0f9e-4d8c-8b7a-6f5e4d3c2b1a",
    "removed": true
  }
}

Was this page helpful?