digitaluapi

<back to all web services

ChannelEmailMessagesAdd

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/channel_email_messages
"use strict";
export class ChannelEmailMessagesAddResponse {
    /** @param {{StatusCodesId?:number,Reference?:string,TenantsId?:number,ChannelMessagesId?:number,Recipients?:string,TemplatesId?:number,TemplateText?:string,DateCreated?:string,DateSent?:string,RetryCount?:number,MessageGuid?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    StatusCodesId;
    /** @type {string} */
    Reference;
    /** @type {number} */
    TenantsId;
    /** @type {number} */
    ChannelMessagesId;
    /** @type {string} */
    Recipients;
    /** @type {number} */
    TemplatesId;
    /** @type {string} */
    TemplateText;
    /** @type {string} */
    DateCreated;
    /** @type {?string} */
    DateSent;
    /** @type {number} */
    RetryCount;
    /** @type {string} */
    MessageGuid;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class ChannelEmailMessagesAdd {
    /** @param {{StatusCodesId?:number,Reference?:string,TenantsId?:number,ChannelMessagesId?:number,Recipients?:string,TemplatesId?:number,TemplateText?:string,DateCreated?:string,DateSent?:string,RetryCount?:number,MessageGuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    StatusCodesId;
    /** @type {string} */
    Reference;
    /** @type {number} */
    TenantsId;
    /** @type {number} */
    ChannelMessagesId;
    /** @type {string} */
    Recipients;
    /** @type {number} */
    TemplatesId;
    /** @type {string} */
    TemplateText;
    /** @type {string} */
    DateCreated;
    /** @type {?string} */
    DateSent;
    /** @type {number} */
    RetryCount;
    /** @type {string} */
    MessageGuid;
}

JavaScript ChannelEmailMessagesAdd DTOs

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 /channel_email_messages HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"StatusCodesId":0,"Reference":"String","TenantsId":0,"ChannelMessagesId":0,"Recipients":"String","TemplatesId":0,"TemplateText":"String","DateCreated":"0001-01-01T00:00:00.0000000+00:00","DateSent":"0001-01-01T00:00:00.0000000+00:00","RetryCount":0,"MessageGuid":"00000000000000000000000000000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"StatusCodesId":0,"Reference":"String","TenantsId":0,"ChannelMessagesId":0,"Recipients":"String","TemplatesId":0,"TemplateText":"String","DateCreated":"0001-01-01T00:00:00.0000000+00:00","DateSent":"0001-01-01T00:00:00.0000000+00:00","RetryCount":0,"MessageGuid":"00000000000000000000000000000000","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}