digitaluapi

<back to all web services

SendCampaignCommunicationsTest

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET POST/campaign/communications/test/{ScheduleInstancesId}Get Campaign Communications

export class SendCampaignCommunicationsResponse
{
    public Status: boolean;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<SendCampaignCommunicationsResponse>) { (Object as any).assign(this, init); }
}

export class SendCampaignCommunicationsTest
{
    // @DataMember(Order=1)
    // @Validate(Validator="NotNull")
    public ScheduleInstancesId: number;

    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    public EmailAddress: string;

    // @DataMember(Order=3)
    // @Validate(Validator="NotNull")
    public MobileNumber: string;

    // @DataMember(Order=3)
    public NoOfRecords: number;

    public constructor(init?: Partial<SendCampaignCommunicationsTest>) { (Object as any).assign(this, init); }
}

TypeScript SendCampaignCommunicationsTest 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 /campaign/communications/test/{ScheduleInstancesId} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ScheduleInstancesId":0,"EmailAddress":"String","MobileNumber":"String","NoOfRecords":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Status":false,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}