MyHome.ie Data Delivery Service

ContactUs

The following routes are available for this service:
GET,POST	/message/contactus

**ContactUs** Parameters:
Name	Parameter	Data Type	Required
Name	body	string	No
Email	body	string	No
Message	body	string	No
ClientInfo	body	List<string>	No

**BaseSendEmailRequest** Parameters:
Name	Parameter	Data Type	Required
Sender	form	SenderEnum	No
ToAddresses	form	List<MailAddress>	No
ReplyToAddress	form	MailAddress	No
CcAddresses	form	List<MailAddress>	No
BccAddresses	form	List<MailAddress>	No
CustomerCopyAddresses	form	List<MailAddress>	No
Subject	form	string	No
RecaptchaResponse	form	string	No
MoreDetails	form	string	No

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required
ApiKey	form	string	No
CorrelationId	form	string	No
ActiveUserId	form	int?	No
Version	form	double	No
RequestTypeId	form	int	No

**SenderEnum** Enum:
WelcomeAt
NotificationAt
LeadAt

**MailAddress** Parameters:
Name	Parameter	Data Type	Required	Description
DisplayName	form	string	No
EmailAddress	form	string	No

**BaseSendMessageResponse** Parameters:
Name	Parameter	Data Type	Required	Description
SentMessage	form	SentMessage	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No

**BaseType** Parameters:
Name	Parameter	Data Type	Required	Description
Version	form	double	No

**SentMessage** Parameters:
Name	Parameter	Data Type	Required
SentMessageId	form	Guid	No
Subject	form	string	No
Body	form	string	No
HtmlBody	form	string	No
IsSpam	form	bool	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 /message/contactus HTTP/1.1 
Host: agentapi.myhome.ie 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Name":"String","Email":"String","Message":"String","ClientInfo":["String"],"Sender":"WelcomeAt","ToAddresses":[{"DisplayName":"String","EmailAddress":"String"}],"ReplyToAddress":{"DisplayName":"String","EmailAddress":"String"},"CcAddresses":[{"DisplayName":"String","EmailAddress":"String"}],"BccAddresses":[{"DisplayName":"String","EmailAddress":"String"}],"CustomerCopyAddresses":[{"DisplayName":"String","EmailAddress":"String"}],"Subject":"String","RecaptchaResponse":"String","MoreDetails":"String","ApiKey":"String","CorrelationId":"String","ActiveUserId":0,"Version":0,"RequestTypeId":0}

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

{"SentMessage":{"SentMessageId":"00000000000000000000000000000000","Subject":"String","Body":"String","HtmlBody":"String","IsSpam":false},"Version":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}