Sign in
Senders

Update Sender

Updates sender settings. Only provided fields are updated. Does not support changing provider or re-verifying credentials.

patch/senders/{id}

Path parameters

idstring uuid required

Resource ID (UUID)

Request body

send_asstring
reply_tostring email
signaturestring
forward_tostring email
disabledboolean
warmboolean
max_per_dayinteger
global_max_per_dayinteger
max_warm_per_dayinteger
warm_email_rampinteger
campaign_ramp_enabledboolean

Enable gradual ramp from start volume to target

campaign_ramp_duration_daysinteger

Days to reach target (required when ramp enabled)

campaign_ramp_start_volumeinteger

Limit on first send day (required when ramp enabled)

SenderProfileIdstring uuid nullable

Response

Sender updated

successboolean
request_idstring

Example response

{
  "success": true,
  "request_id": "req_abc123def456"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.