digitaluapi

<back to all web services

SetCampaignActionForm

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
PUT/campaign/actionformSet Campaign Action Form
"use strict";
export class SetCampaignActionFormResponse {
    /** @param {{Status?:boolean,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    Status;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class FormFieldOption {
    /** @param {{Value?:string,Label?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Value;
    /** @type {string} */
    Label;
}
export class FormField {
    /** @param {{Id?:number,ControlType?:string,Label?:string,Placeholder?:string,Help?:string,Name?:string,SortOrder?:number,Options?:FormFieldOption[],Validation?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    ControlType;
    /** @type {string} */
    Label;
    /** @type {string} */
    Placeholder;
    /** @type {string} */
    Help;
    /** @type {string} */
    Name;
    /** @type {number} */
    SortOrder;
    /** @type {FormFieldOption[]} */
    Options;
    /** @type {string[]} */
    Validation;
}
export class SetCampaignActionForm {
    /** @param {{CampaignsId?:number,CampaignActionsId?:number,FormMeta?:FormField[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    CampaignsId;
    /** @type {number} */
    CampaignActionsId;
    /** @type {FormField[]} */
    FormMeta;
}

JavaScript SetCampaignActionForm DTOs

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

HTTP + JSV

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

PUT /campaign/actionform HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CampaignsId: 0,
	CampaignActionsId: 0,
	FormMeta: 
	[
		{
			Id: 0,
			ControlType: String,
			Label: String,
			Placeholder: String,
			Help: String,
			Name: String,
			SortOrder: 0,
			Options: 
			[
				{
					Value: String,
					Label: String
				}
			],
			Validation: 
			[
				String
			]
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}