Mailboxes

Change a mailbox

Daily cold email limit, warm-up on or off, whether it may send, display name and time zone. Only the fields you send change.

CostWhat it doesKey scopes
FreeWritesargorant:manage_lists
patch/api/v1/inboxes/{email}

Request

  • Base URL: https://app.argorant.com
  • URL: https://app.argorant.com/api/v1/inboxes/{email}
  • Auth: HTTP bearer

Path parameters

emailstring email required

The mailbox address.

Headers

Idempotency-Keystring

Any unique text up to 128 characters. A retry with the same key and the same body within 24 hours returns the first answer (with the header Idempotent-Replayed: true) instead of doing the work twice. The same key with another body answers 409 idempotency_conflict.

X-Request-Idstring

Your own id for this request, 8 to 64 letters, digits, dot, dash or underscore. Returned as X-Request-Id; one is made for you when you send none.

Request body

daily_limitinteger

Cold emails a day.

warmupboolean

Warm-up on or off.

activeboolean

May send.

display_namestring

Name shown to recipients.

timezonestring

Time zone name.

Response

OK

changedstring[]

Changes

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