Create a new domain

POST 
/v1/domain/add

This endpoint creates a new domain

Request

application/json

Body

required

Domain Payload

custom_args

object

property name* any
domain stringrequired
ips string[]
is_tenant_domain boolean
is_tenant_subdomain boolean
selector string
shared_with_subaccounts boolean

Responses

200

Domain added successfully

application/json

Schema

Schema

is_tenant_domain boolean
mailer_id 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
verified boolean

Example (from schema)

{
  "is_tenant_domain": true,
  "mailer_id": "string",
  "message": "event success",
  "receiving_records": {},
  "sending_records": {},
  "verified": true
}

400

error: Bad Request

application/json

Schema

Schema

error string
success boolean

Example (from schema)

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

404

error: Not Found

application/json

Schema

Schema

error string
success boolean

Example (from schema)

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

Loading...