Update a sender

Change a sender's display name, daily and weekly limits, warm-up ramp or LinkedIn premium flag. Omitted fields keep their value; the weekly limit may not be below the daily one.

PATCHhttps://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.

Body

display_namestring | nulloptional
The name recipients see on this sender. Null clears it. Omit to keep it.
daily_limitintegeroptional
Most sends a day, 0 to 2000. The ramp may hold a warming account below it.
weekly_limitintegeroptional
Most sends a week, 0 to 10000. Not below the daily limit.
ramp_enabledbooleanoptional
Whether a new account works up to its limits gradually. Turn it off only for an account that is already warm.
premiumbooleanoptional
LinkedIn only: whether the account can add a note to an invitation.

Request

curl -X PATCH 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",
    "saved": true
  }
}

Was this page helpful?