Tenants

Create a tenant

post/tenants

Request

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

Request body

external_idstring required

Your id for this customer. Unique in your account; cannot change.

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.

Response

Tenant created

Changes

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