POST | Creates and new email and, if a Collection Attempt is provided add's a note to the attempt |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ToEmailAddress | body | string | Yes | The To email address. |
FromEmail | body | string | Yes | The From email address. |
EmailMessage | body | string | Yes | The email Message. |
EmailSubject | body | string | Yes | The email Subject. |
EmailisHtml | body | bool | No | Set to true if the body of EmailMessage is in HTML format |
CollectionAttemptID | body | Guid | No | The collection attempt ID. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Success | form | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /email HTTP/1.1
Host: api.paylock.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"toEmailAddress":"String","fromEmail":"String","emailMessage":"String","emailSubject":"String","emailisHtml":false,"collectionAttemptID":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"success":false}