| Requires any of the roles: | admin, oauthadmin |
| GET | /Ams/{ClientID}/DomainAuthentication | Return a list of Domain VerificationInfo under AWS. | |
|---|---|---|---|
| POST | /Ams/{ClientID}/DomainAuthentication | Start a new Domain Verification. | |
| PUT | /Ams/{ClientID}/DomainAuthentication | Update an existing Domain Verification. | |
| GET | /Ams/{ClientID}/DomainAuthentication/{DomainId} | Return details of Domain VerificationInfo for given DomainId. | |
| DELETE | /Ams/{ClientID}/DomainAuthentication/{DomainId} | Delete a Domain Verification. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Domain | body | string | No | |
| DomainId | path | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MemberID | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClientID | form | int | No | |
| ResponseStatus | form | ResponseStatus | No | |
| BypassCache | form | bool | No | |
| DateCached | form | DateTime | No | |
| Device | form | Device | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DomainAuthenticationInfoList | form | List<DomainAuthenticationInfo> | No | |
| ValidationRoute | form | ValidationRoute | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DomainId | form | int | No | |
| DomainName | form | string | No | |
| IsYmMangedDomain | form | bool | No | |
| EmailsCount | form | int | No | |
| DomainStatus | form | DomainStatus | No | |
| IdentityZoneRecord | form | ZoneRecord | No | |
| DkimZoneRecords | form | List<ZoneRecord> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IdentityStatus | form | Status | No | |
| DkimStatus | form | Status | No | |
| CombinedStatus | form | Status | No | |
| DisplayName | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Host | form | string | No | |
| Value | form | string | No | |
| RecordType | form | string | No | |
| TTL | form | long | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Ams/{ClientID}/DomainAuthentication HTTP/1.1
Host: ws.yourmembership.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"Domain":"String","DomainId":0,"MemberID":0,"ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2025-01-15T08:48:15.7419274-05:00","Device":"Desktop"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"DomainAuthenticationInfoList":[{"DomainId":0,"DomainName":"String","IsYmMangedDomain":false,"EmailsCount":0,"DomainStatus":{"IdentityStatus":"Undefined","DkimStatus":"Undefined","CombinedStatus":"Undefined","DisplayName":"String"},"IdentityZoneRecord":{"Host":"String","Value":"String","RecordType":"String","TTL":0},"DkimZoneRecords":[{"Host":"String","Value":"String","RecordType":"String","TTL":0}]}],"ValidationRoute":"Undefined","Domain":"String","DomainId":0,"MemberID":0,"ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2025-01-15T08:48:15.7576676-05:00","Device":"Desktop"}