Organization API: Customer Portal: Domains

The 6 Organization API operations for domains.

View as Markdown

Operations

Method	Path	Summary
GET	`/api/v1/orgs/{org_slug}/portal/mail/{service_id}/domains`	List domains
POST	`/api/v1/orgs/{org_slug}/portal/mail/{service_id}/domains`	Add domain
DELETE	`/api/v1/orgs/{org_slug}/portal/mail/{service_id}/domains/{domain_id}`	Remove domain
PATCH	`/api/v1/orgs/{org_slug}/portal/mail/{service_id}/domains/{domain_id}/dmarc`	Set DMARC
GET	`/api/v1/orgs/{org_slug}/portal/mail/{service_id}/domains/{domain_id}/records`	Domain records
POST	`/api/v1/orgs/{org_slug}/portal/mail/{service_id}/domains/{domain_id}/verify`	Verify domain

List domains

Section titled List domains

GET /api/v1/orgs/{org_slug}/portal/mail/{service_id}/domains

Parameters

Section titled Parameters

Name	In	Type	Required
`org_slug`	path	string	yes
`service_id`	path	integer	yes

Responses

Section titled Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Add domain

Section titled Add domain

POST /api/v1/orgs/{org_slug}/portal/mail/{service_id}/domains

Parameters

Section titled Parameters

Name	In	Type	Required
`org_slug`	path	string	yes
`service_id`	path	integer	yes

Request body

Section titled Request body

application/json (required)

Field	Type	Required
`domain`	string	yes
`primary`	boolean	no

Responses

Section titled Responses

Status	Meaning
`201`	Success.
`422`	The request is not valid. `detail` lists each problem.

Remove domain

Section titled Remove domain

DELETE /api/v1/orgs/{org_slug}/portal/mail/{service_id}/domains/{domain_id}

Parameters

Section titled Parameters

Name	In	Type	Required
`domain_id`	path	integer	yes
`org_slug`	path	string	yes
`service_id`	path	integer	yes

Responses

Section titled Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Set DMARC

Section titled Set DMARC

PATCH /api/v1/orgs/{org_slug}/portal/mail/{service_id}/domains/{domain_id}/dmarc

Parameters

Section titled Parameters

Name	In	Type	Required
`domain_id`	path	integer	yes
`org_slug`	path	string	yes
`service_id`	path	integer	yes

Request body

Section titled Request body

application/json (required)

Field	Type	Required
`stage`	string or null	no
`pinned`	boolean or null	no

Responses

Section titled Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Domain records

Section titled Domain records

GET /api/v1/orgs/{org_slug}/portal/mail/{service_id}/domains/{domain_id}/records

Parameters

Section titled Parameters

Name	In	Type	Required
`domain_id`	path	integer	yes
`org_slug`	path	string	yes
`service_id`	path	integer	yes

Responses

Section titled Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Verify domain

Section titled Verify domain

POST /api/v1/orgs/{org_slug}/portal/mail/{service_id}/domains/{domain_id}/verify

Parameters

Section titled Parameters

Name	In	Type	Required
`domain_id`	path	integer	yes
`org_slug`	path	string	yes
`service_id`	path	integer	yes

Responses

Section titled Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.