Skip to main content
POST
/
v2
/
tenant
Create Tenant
curl --request POST \
  --url https://platform.sendr.app/api/v2/tenant \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "domain": "<string>",
  "sendingEmail": "jsmith@example.com"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "domain": "<string>",
  "sendingEmail": "jsmith@example.com",
  "currentEmailCount": 123
}
Create a new domain/workspace in the system. Each tenant can have one domain associated with it.

​
Features

  • Workspace/tenant creation
  • Domain association
  • Default email configuration
  • Automatic API key generation
  • DNS verification preparation

​
Required Fields

  • name: Workspace/tenant name (usually company name)
  • domain: Default domain name
  • email: Default sending email address

​
Response

  • 201 Created: Tenant created successfully
  • 400 Bad Request: Invalid request parameters
  • 401 Unauthorized: Invalid API key
  • 409 Conflict: Tenant or domain already exists
After creating a tenant, you’ll need to verify your domain’s DNS settings before sending emails.

Authorizations

​
Authorization
string
header
required

Body

application/json
​
name
string
required

Workspace/tenant name

​
domain
string
required

Default domain name

​
sendingEmail
string<email>
required

Default sending email address

Response

Tenant created successfully

​
id
string<uuid>

Tenant identifier

​
name
string

Workspace/tenant name

​
createdAt
string<date-time>

Creation timestamp

​
updatedAt
string<date-time>

Last update timestamp

​
domain
string

Domain name

​
sendingEmail
string<email>

Default sending email address

​
currentEmailCount
integer

Current email count