Sending Domains
Get All Sending Domains [GET]
get
/domain/sending
Request
GET
/domain/sendingParameters
pageintegeroptional
Type: query
Description:
Default Value: 1
sizeintegeroptional
Type: query
Description:
Default Value: 10
searchstringoptional
Type: query
Description:
statusstringoptional
Type: query
Description:
Parameters
GET
/domain/sending?page=1&size=10&search=string&status=stringResponse
| Code | Description | Type |
|---|---|---|
| 200 | array | |
array of object Object Properties countinteger sendingDomainarray of object Object Properties assignmentstring companyIdinteger createdAtinteger defaultboolean domainstring idinteger statusstring subAccountIDinteger subAccountNamestring typesarray of string | ||
| 400 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
| 401 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
| 500 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
Response
200
400
401
500
Create Sending Domain [POST]
post
/domain/sending
Request
POST
/domain/sendingRequest Body
Sending domain data
assignmentstringoptional
Description:
Example: Share with all Subaccounts
domainstringrequired
Description:
Example: example.com
notestringoptional
Description:
Request Body
{
"assignment": "Share with all Subaccounts",
"domain": "example.com",
"note": "string"
}
Response
| Code | Description | Type |
|---|---|---|
| 201 | object | |
Object Properties assignmentstring cnameHostnamestring cnameValuestring cnameVerifiedboolean createdAtinteger dkimHostnamestring dkimPrivateKeystring dkimPublicKeystring dkimSelectorstring dkimValuestring dkimVerifiedboolean domainstring idinteger spfHostnamestring spfValuestring spfVerifiedboolean statusarray of string subAccountIdinteger subAccountNamestring trackingDomainIdinteger trackingDomainNamestring typesarray of string | ||
| 400 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
| 401 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
| 500 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
Response
201
400
401
500
Get Unverified SPF [GET]
get
/domain/sending/unverified-spf
Request
GET
/domain/sending/unverified-spfResponse
| Code | Description | Type |
|---|---|---|
| 200 | object | |
Object Properties countinteger dataarray of object Object Properties idinteger namestring | ||
| 400 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
| 401 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
| 500 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
Response
200
400
401
500
Get Sending Domain by ID [GET]
get
/domain/sending/{id}
Request
GET
/domain/sending/{id}Parameters
idintegerrequired
Type: path
Description:
Parameters
GET
/domain/sending/1Response
| Code | Description | Type |
|---|---|---|
| 200 | object | |
Object Properties assignmentstring cnameHostnamestring cnameValuestring cnameVerifiedboolean createdAtinteger dkimHostnamestring dkimPrivateKeystring dkimPublicKeystring dkimSelectorstring dkimValuestring dkimVerifiedboolean domainstring idinteger spfHostnamestring spfValuestring spfVerifiedboolean statusarray of string subAccountIdinteger subAccountNamestring trackingDomainIdinteger trackingDomainNamestring typesarray of string | ||
| 400 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
| 401 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
| 500 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
Response
200
400
401
500
Delete Sending Domain [DELETE]
delete
/domain/sending/{id}
Request
DELETE
/domain/sending/{id}Parameters
idintegerrequired
Type: path
Description:
Parameters
DELETE
/domain/sending/1Response
| Code | Description | Type |
|---|---|---|
| 200 | string | |
| 400 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
| 401 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
| 500 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
Response
200
400
401
500
Share Sending Domain [PUT]
put
/domain/sending/{id}/share
Request
PUT
/domain/sending/{id}/shareParameters
idintegerrequired
Type: path
Description:
Parameters
PUT
/domain/sending/1/shareResponse
| Code | Description | Type |
|---|---|---|
| 200 | object | |
Object Properties assignmentstring cnameHostnamestring cnameValuestring cnameVerifiedboolean createdAtinteger dkimHostnamestring dkimPrivateKeystring dkimPublicKeystring dkimSelectorstring dkimValuestring dkimVerifiedboolean domainstring idinteger spfHostnamestring spfValuestring spfVerifiedboolean statusarray of string subAccountIdinteger subAccountNamestring trackingDomainIdinteger trackingDomainNamestring typesarray of string | ||
| 400 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
| 401 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
| 500 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
Response
200
400
401
500
Get SPF Suggestion [GET]
get
/domain/sending/{id}/spf-suggestion
Request
GET
/domain/sending/{id}/spf-suggestionParameters
idintegerrequired
Type: path
Description:
Parameters
GET
/domain/sending/1/spf-suggestionResponse
| Code | Description | Type |
|---|---|---|
| 200 | object | |
Object Properties notestring spfRecordsarray of string suggestionstring | ||
| 400 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
| 401 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
| 500 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
Response
200
400
401
500
Verify TXT Domain [PUT]
put
/domain/sending/{id}/verify-txt
Request
PUT
/domain/sending/{id}/verify-txtParameters
idintegerrequired
Type: path
Description:
Parameters
PUT
/domain/sending/1/verify-txtResponse
| Code | Description | Type |
|---|---|---|
| 200 | array | |
array of object Object Properties assignmentstring cnameHostnamestring cnameValuestring cnameVerifiedboolean createdAtinteger dkimHostnamestring dkimPrivateKeystring dkimPublicKeystring dkimSelectorstring dkimValuestring dkimVerifiedboolean domainstring idinteger spfHostnamestring spfValuestring spfVerifiedboolean statusarray of string subAccountIdinteger subAccountNamestring trackingDomainIdinteger trackingDomainNamestring typesarray of string | ||
| 400 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
| 401 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
| 500 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
Response
200
400
401
500