Tenants

Create a tenant

Create a new tenant.

Returns the created tenant with a unique id. Store this ID in your database to reference this tenant later.

post/tenants

Request body

namestring required

Display name for the tenant (e.g., your customer's company name)

metadataTenantMetadata nullable

Custom key-value pairs. Useful for storing references to your internal systems.

Limits:

Max 50 keys
Key names max 40 characters
String values max 500 characters
Total size max 8KB

Example request

{
  "name": "Acme Corp",
  "metadata": {
    "plan": "pro",
    "internalId": "cust_12345",
    "region": "us-west"
  }
}

Response

Tenant created

successtrue required

Example response

{
  "data": {
    "id": "cm6abc123def456ghi789",
    "name": "Acme Corp",
    "metadata": {
      "plan": "pro",
      "internalId": "cust_12345"
    },
    "status": "active",
    "createdAt": "2026-02-03T10:30:00Z",
    "updatedAt": "2026-02-03T10:30:00Z"
  },
  "meta": {
    "requestId": "req_V1StGXR8_Z5jdHi6"
  }
}

Changes

Changed in 3 of the 49 revisions of this API.21887

Feb 5, 202637bce0c9a4d744See the full diff
- ●
  added the new infrastructure_error enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new infrastructure_error enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new infrastructure_error enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new infrastructure_error enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ○
  removed the postal_error enum value from the error/code response property for the response status 400
  response-property-enum-value-removed
- ○
  removed the postal_error enum value from the error/code response property for the response status 401
  response-property-enum-value-removed
- ○
  removed the postal_error enum value from the error/code response property for the response status 429
  response-property-enum-value-removed
- ○
  removed the postal_error enum value from the error/code response property for the response status 500
  response-property-enum-value-removed
Feb 4, 20264f8eeb0b993321842See the full diff
- ▲
  removed the required property data/created_at from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property data/updated_at from the response with the 201 status
  response-required-property-removed
- ●
  added the new already_exists enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new already_exists enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new already_exists enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new already_exists enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new attachment_too_large enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new attachment_too_large enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new attachment_too_large enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new attachment_too_large enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new authentication_required enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new authentication_required enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new authentication_required enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new authentication_required enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new billing_error enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new billing_error enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new billing_error enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new billing_error enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new billing_not_configured enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new billing_not_configured enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new billing_not_configured enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new billing_not_configured enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new credential_not_found enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new credential_not_found enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new credential_not_found enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new credential_not_found enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new credential_on_hold enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new credential_on_hold enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new credential_on_hold enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new credential_on_hold enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new credential_revoked enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new credential_revoked enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new credential_revoked enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new credential_revoked enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new delivery_not_found enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new delivery_not_found enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new delivery_not_found enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new delivery_not_found enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new domain_already_exists enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new domain_already_exists enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new domain_already_exists enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new domain_already_exists enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new domain_not_found enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new domain_not_found enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new domain_not_found enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new domain_not_found enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new domain_not_verified enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new domain_not_verified enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new domain_not_verified enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new domain_not_verified enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new email_not_found enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new email_not_found enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new email_not_found enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new email_not_found enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new external_id_already_exists enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new external_id_already_exists enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new external_id_already_exists enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new external_id_already_exists enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new forbidden enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new forbidden enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new forbidden enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new forbidden enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new idempotency_conflict enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new idempotency_conflict enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new idempotency_conflict enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new idempotency_conflict enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new insufficient_balance enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new insufficient_balance enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new insufficient_balance enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new insufficient_balance enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new internal_error enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new internal_error enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new internal_error enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new internal_error enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new invalid_api_key enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new invalid_api_key enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_api_key enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_api_key enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new invalid_email_address enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new invalid_email_address enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_email_address enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_email_address enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new invalid_raw_message enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new invalid_raw_message enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_raw_message enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_raw_message enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new invalid_request enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new invalid_request enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_request enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_request enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new ip_not_allowed enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new ip_not_allowed enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new ip_not_allowed enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new ip_not_allowed enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new message_too_large enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new message_too_large enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new message_too_large enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new message_too_large enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new metadata_key_invalid enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new metadata_key_invalid enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new metadata_key_invalid enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new metadata_key_invalid enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new metadata_too_large enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new metadata_too_large enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new metadata_too_large enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new metadata_too_large enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new metadata_value_invalid enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new metadata_value_invalid enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new metadata_value_invalid enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new metadata_value_invalid enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new missing_field enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new missing_field enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new missing_field enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new missing_field enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new missing_scope enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new missing_scope enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new missing_scope enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new missing_scope enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new not_found enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new not_found enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new not_found enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new not_found enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new payload_too_large enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new payload_too_large enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new payload_too_large enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new payload_too_large enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new payment_required enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new payment_required enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new payment_required enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new payment_required enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new postal_error enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new postal_error enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new postal_error enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new postal_error enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new rate_limit_exceeded enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new rate_limit_exceeded enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new rate_limit_exceeded enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new rate_limit_exceeded enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new send_limit_exceeded enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new send_limit_exceeded enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new send_limit_exceeded enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new send_limit_exceeded enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new server_suspended enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new server_suspended enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new server_suspended enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new server_suspended enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new service_unavailable enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new service_unavailable enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new service_unavailable enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new service_unavailable enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new suppressed_recipient enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new suppressed_recipient enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new suppressed_recipient enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new suppressed_recipient enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new suppression_not_found enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new suppression_not_found enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new suppression_not_found enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new suppression_not_found enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new tenant_not_found enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new tenant_not_found enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new tenant_not_found enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new tenant_not_found enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new too_many_attachments enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new too_many_attachments enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new too_many_attachments enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new too_many_attachments enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new too_many_recipients enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new too_many_recipients enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new too_many_recipients enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new too_many_recipients enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new unauthenticated_from_address enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new unauthenticated_from_address enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new unauthenticated_from_address enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new unauthenticated_from_address enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new unprocessable_entity enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new unprocessable_entity enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new unprocessable_entity enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new unprocessable_entity enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new validation_error enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new validation_error enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new validation_error enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new validation_error enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new webhook_not_found enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new webhook_not_found enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new webhook_not_found enum value to the error/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new webhook_not_found enum value to the error/code response property for the response status 500
  response-property-enum-value-added
- ○
  added the required property data/createdAt to the response with the 201 status
  response-required-property-added
- ○
  added the required property data/updatedAt to the response with the 201 status
  response-required-property-added
Feb 3, 2026628db0b9b7c91See the full diff
- ○
  endpoint added
  endpoint-added

Full history