Browse the docs

PATCH /account

Change account settings. postal_address is the sender address printed in every broadcast footer; a broadcast is not sent until it is set. null clears it.

Parameters

  • Idempotency-Key header · string · optional — Makes this call safe to retry. Send the same key with the same body and the original response is replayed instead of the work happening twice. Keys are 1-256 characters and are remembered for 7 days. While the first attempt is still running, a second call with that key returns 409 idempotency_in_flight (Resend calls this concurrent_idempotent_requests); the same key with a different body returns 409 idempotency_payload_mismatch (Resend: invalid_idempotent_request). Resend-Idempotency-Key is accepted as the same header.
  • Resend-Idempotency-Key header · string · optional — Alias of Idempotency-Key. Idempotency-Key wins if both are sent.

Request body

FieldTypeRequiredNotes
postal_addressstring | nullyes

Responses

  • 200 — Success
  • 400 — Validation error
  • 401 — Missing API key
  • 403 — Forbidden
  • 404 — Not found
  • 409 — Conflict
  • 429 — Rate limited
  • 500 — Internal server error

Response headers

  • ratelimit-limit — Messages this API key may spend in one 60-second window.
  • ratelimit-remaining — Messages left in the current window.
  • ratelimit-reset — Seconds until the current window resets and the budget refills.

200 body

FieldTypeRequiredNotes
approval_reasonstring | nullyes
created_atstringyes
idstringyes
is_review_accountbooleanyes
namestringyes
onboardingobjectyes
onboarding.checklist_dismissed_atstring | nullyes
onboarding.companystringyes
onboarding.completed_atstring | nullyes
onboarding.connect_agent_moment_duebooleanyes
onboarding.contact_namestring | nullyes
onboarding.expected_volume"under_30k" | "30k_100k" | "100k_1m" | "over_1m" | nullyes
onboarding.use_casesarray<"transactional" | "product_lifecycle" | "ai_agents">yes
onboarding.websitestring | nullyes
onboarding.website_domainstring | nullyes
onboarding_senderobject | nullyes
postal_addressstring | nullyes
status"sandboxed" | "approved" | "suspended"yes

Errors

The codes this operation can answer with, and what to do about each. Every one arrives with its code, message, fix and docs_url.

  • idempotency_in_flight (409) — A request with this Idempotency-Key is still in progress. Fix: Wait and retry with the same Idempotency-Key to receive the original response.
  • idempotency_payload_mismatch (409) — Same Idempotency-Key was used with a different payload. Fix: Reuse the exact same body for retries, or send a new Idempotency-Key for a new request.
  • internal_server_error (500) — Unexpected error. Fix: Retry ONCE after a short pause, with the same Idempotency-Key so the retry cannot double-send. If it fails again, stop retrying and report the x-request-id from the response — that id is what identifies this exact failure in support.
  • invalid_idempotency_key (400) — Idempotency-Key must be 1-256 characters. Fix: Send a non-empty Idempotency-Key header of at most 256 characters.
  • payload_too_large (413) — Request body is larger than this endpoint accepts. Fix: Send a smaller body. Most endpoints accept 1 MB. Sends (POST /emails, /emails/batch, replies) and template, broadcast and automation edits accept 50 MB, which fits 40 MB of attachments after base64. /mcp accepts 1 MB per JSON-RPC call.
  • rate_limit_exceeded (429) — Too many requests. Fix: Back off and retry honoring the Retry-After header.
  • unsupported_media_type (415) — This endpoint does not accept that content type. Fix: Send the body as JSON with `Content-Type: application/json`.
  • validation_error (400) — Error in one or more fields. Fix: Correct the fields listed in the error details and retry the request.