Tenants

Update, pause or resume a tenant

Change any setting from create (except external_id, which cannot change), or pause and resume the tenant with status and an optional reason. A paused tenant's new sends get 403 forbidden; your other tenants keep sending. A tenant Groundmail paused (pause_source automated or admin) cannot be resumed here: fix the cause and contact support.

patch/tenants/{id}

Request

  • Base URL: https://api.groundmail.dev
  • URL: https://api.groundmail.dev/tenants/{id}
  • Auth: HTTP bearer

Request body

namestring

Display name. Defaults to external_id.

default_from_domainstring nullable

Completes a bare from local part ("billing" → billing@<domain>) on sends that name this tenant.

stream_policy'all' | 'transactional_only'

transactional_only refuses product email for this tenant.

daily_limitinteger nullable

Most recipients this tenant may email per UTC day, on top of its sending ramp. null for no limit of your own.

metadataobject nullable

Any JSON object, up to 4 KB, for your own use.

status'active' | 'paused'

paused stops the tenant's new sends; active resumes them.

reasonstring nullable

Why you paused the tenant.

Response

The updated tenant

Changes

No recorded changes to this operation across all 2 revisions of this API.