Create a new domain

POST 
/superadmin/tenant/:id/subaccount/:accountId/domain

Create a new domain for an account

Request

Path Parameters

id integerrequired

Tenant ID

accountId integerrequired

Account ID

application/json

Body

required

Domain details

custom_args

object

property name* any
domain stringrequired
is_tenant_domain boolean
is_tenant_subdomain boolean

Responses

200

OK

application/json

Schema

Schema

is_tenant_domain boolean
mailer_id string
mailer_service_id integer
mailer_service_name string
message string

receiving_records

object

property name*

object

key string

type string

value string

verified boolean

sending_records

object

property name*

object

key string

type string

value string

verified boolean
success boolean
verified boolean

Example (from schema)

{
  "is_tenant_domain": true,
  "mailer_id": "string",
  "mailer_service_id": 0,
  "mailer_service_name": "string",
  "message": "string",
  "receiving_records": {},
  "sending_records": {},
  "success": true,
  "verified": true
}

400

Bad Request

application/json

Schema

Schema

error string
success boolean

Example (from schema)

{
  "error": "string",
  "success": true
}

404

Not Found

application/json

Schema

Schema

error string
success boolean

Example (from schema)

{
  "error": "string",
  "success": true
}

409

Conflict

application/json

Schema

Schema

error string
success boolean

Example (from schema)

{
  "error": "string",
  "success": true
}

500

Internal Server Error

application/json

Schema

Schema

error string
success boolean

Example (from schema)

{
  "error": "string",
  "success": true
}

Loading...