YM REST Services

EmailVerification

**Requires Authentication**
Requires any of the roles:	admin, oauthadmin, admin, oauthadmin, admin, oauthadmin, admin, oauthadmin

The following routes are available for this service:
GET	/Ams/{ClientID}/EmailVerification	Return a list of email verificationInfo under AWS.
POST	/Ams/{ClientID}/EmailVerification	Start a new email verification.
GET	/Ams/{ClientID}/EmailVerification/{DomainId}	Return a list of email verificationInfo under given Domainid.
POST	/Ams/{ClientID}/EmailVerification/{DomainId}	Start a new email verification under given DomainId.
PUT	/Ams/{ClientID}/EmailVerification/{EmailId}	Update an admin announcement details.
DELETE	/Ams/{ClientID}/EmailVerification/{EmailId}	Delete an email verification.

**EmailVerification** Parameters:
Name	Parameter	Data Type	Required
EmailId	path	int	No
Email	body	EmailAddress	No
IsReSend	body	bool	No
DomainId	path	int	No

**MemberBaseSharedDto** Parameters:
Name	Parameter	Data Type	Required	Description
MemberID	form	int	No

**BaseSharedDto** Parameters:
Name	Parameter	Data Type	Required
ClientID	form	int	No
ResponseStatus	form	ResponseStatus	No
BypassCache	form	bool	No
DateCached	form	DateTime	No
Device	form	Device	No

**EmailAddress** Parameters:
Name	Parameter	Data Type	Required
Address	form	string	No
DisplayName	form	string	No
Host	form	string	No
User	form	string	No

**EmailVerificationResponse** Parameters:
Name	Parameter	Data Type	Required	Description
EmailverificationInfoList	form	List<EmailverificationInfo>	No

**EmailverificationInfo** Parameters:
Name	Parameter	Data Type	Required
EmailId	form	int	No
Email	form	EmailAddress	No
EmailStatus	form	EmailStatus	No
DomainId	form	int	No

**EmailStatus** Parameters:
Name	Parameter	Data Type	Required	Description
Status	form	Status	No
DisplayName	form	string	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Ams/{ClientID}/EmailVerification HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"EmailId":0,"Email":{"DisplayName":"String","Host":"String","User":"String"},"IsReSend":false,"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-15T09:06:13.5746026-05:00","Device":"Desktop"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"EmailverificationInfoList":[{"EmailId":0,"Email":{"DisplayName":"String","Host":"String","User":"String"},"EmailStatus":{"Status":"Undefined","DisplayName":"String"},"DomainId":0}],"EmailId":0,"Email":{"DisplayName":"String","Host":"String","User":"String"},"IsReSend":false,"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-15T09:06:13.5902149-05:00","Device":"Desktop"}