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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<SetCampaignActionForm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <CampaignActionsId>0</CampaignActionsId>
  <CampaignsId>0</CampaignsId>
  <FormMeta>
    <FormField>
      <ControlType>String</ControlType>
      <Help>String</Help>
      <Id>0</Id>
      <Label>String</Label>
      <Name>String</Name>
      <Options>
        <FormFieldOption>
          <Label>String</Label>
          <Value>String</Value>
        </FormFieldOption>
      </Options>
      <Placeholder>String</Placeholder>
      <SortOrder>0</SortOrder>
      <Validation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Validation>
    </FormField>
  </FormMeta>
</SetCampaignActionForm>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SetCampaignActionFormResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Status>false</Status>
</SetCampaignActionFormResponse>