digitaluapi

<back to all web services

CampaignsAdd

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/campaigns

export class CampaignsAddResponse
{
    // @DataMember(Order=2)
    public TenantsId: number;

    // @DataMember(Order=3)
    public Name: string;

    // @DataMember(Order=4)
    public Description: string;

    // @DataMember(Order=5)
    public AvatarsId: number;

    // @DataMember(Order=6)
    public SchedulesId: number;

    // @DataMember(Order=7)
    public MessageTonesId: number;

    // @DataMember(Order=8)
    public StatusCodesId: number;

    // @DataMember(Order=10)
    public ResponseStatus: ResponseStatus;

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

// @DataContract
export class CampaignsAdd
{
    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    public TenantsId: number;

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

    // @DataMember(Order=4)
    // @Validate(Validator="NotNull")
    public Description: string;

    // @DataMember(Order=5)
    // @Validate(Validator="NotNull")
    public AvatarsId: number;

    // @DataMember(Order=6)
    // @Validate(Validator="NotNull")
    public SchedulesId: number;

    // @DataMember(Order=7)
    // @Validate(Validator="NotNull")
    public MessageTonesId: number;

    // @DataMember(Order=8)
    // @Validate(Validator="NotNull")
    public StatusCodesId: number;

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

TypeScript CampaignsAdd DTOs

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

HTTP + OTHER

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

POST /campaigns HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"TenantsId":0,"Name":"String","Description":"String","AvatarsId":0,"SchedulesId":0,"MessageTonesId":0,"StatusCodesId":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"TenantsId":0,"Name":"String","Description":"String","AvatarsId":0,"SchedulesId":0,"MessageTonesId":0,"StatusCodesId":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}