Marketo Engage Rest API (1.0)

Download OpenAPI specification:Download

URL: https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/home License: API License Agreement Terms of Service

Marketo Engage Rest API

Channels

Channel Controller

Get Channel by Name

Retrieves channels based on the provided name. Required Permissions: Read-Only Assets, Read-Write Assets

Request
query Parameters
Name
required
string

Name of channel to retrieve

Responses
200

OK

get/rest/asset/v1/channel/byName.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Channels

Retrieves all channels. Required Permissions: Read-Only Assets, Read-Write Assets

Request
query Parameters
maxReturn
integer <int32>

Maximum number of channels to return. Max 200, default 20

offset
integer <int32>

Integer offset for paging

Responses
200

OK

get/rest/asset/v1/channels.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Email Templates

Email Template Controller

Get Email Template by Name

Retrieves and email template record by the given name. Required Permissions: Read-Only Assets, Read-Write Assets

Request
query Parameters
name
required
string

name

status
string

Status filter for draft or approved versions

Enum: "approved" "draft"
Responses
200

OK

get/rest/asset/v1/emailTemplate/byName.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Email Template by Id

Returns an email template record by its id. Required Permissions: Read-Only Assets, Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

query Parameters
status
string

Status filter for draft or approved versions

Enum: "approved" "draft"
Responses
200

OK

get/rest/asset/v1/emailTemplate/{id}.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Update Email Template Metadata

Updates the metadata for the designated email template. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Request Body schema: application/x-www-form-urlencoded
required

updateEmailMetaDataRequest

description
string

Description of the asset

name
string

Name of the Email Template

Responses
200

OK

post/rest/asset/v1/emailTemplate/{id}.json
Request samples
application/x-www-form-urlencoded
description=string&name=string
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Approve Email Template Draft

Approves the current draft of the email template. Required Permissions: Approve Assets

Request
path Parameters
id
required
integer <int32>

id

Responses
200

OK

post/rest/asset/v1/emailTemplate/{id}/approveDraft.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Clone Email Template

Clones the designated email template. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Request Body schema: application/x-www-form-urlencoded
required

cloneEmailTemplateRequest

description
string

Description of the asset

required
object (Folder)

JSON representation of a folder

name
required
string

Name of the Email Template

Responses
200

OK

post/rest/asset/v1/emailTemplate/{id}/clone.json
Request samples
application/x-www-form-urlencoded
description=string&id=0&type=Folder&name=string
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Email Template Content by Id

Returns the content for a given email template. Required Permissions: Read-Only Assets, Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

query Parameters
status
string

Status filter for draft or approved versions

Enum: "approved" "draft"
Responses
200

OK

get/rest/asset/v1/emailTemplate/{id}/content
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Update Email Template Content

Updates the content of the given email template. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Request Body schema: multipart/form-data

updateEmailTemplateContentRequest

content
string

Content for the email template. Multipart file.

Responses
200

OK

post/rest/asset/v1/emailTemplate/{id}/content.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Delete Email Template

Deletes the designated email template. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Responses
200

OK

post/rest/asset/v1/emailTemplate/{id}/delete.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Discard Email Template Draft

Discards the current draft of the email template. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Responses
200

OK

post/rest/asset/v1/emailTemplate/{id}/discardDraft.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Unapprove Email Template Draft

Unapproves the current approved version of the Email Template. Required Permissions: Approve Assets

Request
path Parameters
id
required
integer <int32>

id

Responses
200

OK

post/rest/asset/v1/emailTemplate/{id}/unapprove.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Email Templates

Returns a list of email template records accessible in the target instance. Required Permissions: Read-Only Assets, Read-Write Assets

Request
query Parameters
offset
integer <int32>

Integer offset for paging

maxReturn
integer <int32>

Maximum number of channels to return. Max 200, default 20

status
string

Status filter for draft or approved versions

Enum: "approved" "draft"
Responses
200

OK

get/rest/asset/v1/emailTemplates.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Create Email Template

Creates a new email template. Required Permissions: Read-Write Assets

Request
Request Body schema: multipart/form-data
required

createEmailTemplateRequest

name
required
string

Name of the Email Template. Must be unique under the parent folder.

required
object (Folder)

JSON representation of a folder

description
string

Description of the email template

content
required
string

HTML content for template. Multipart file.

Responses
200

OK

post/rest/asset/v1/emailTemplates.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Email Template Used By

Returns a list of email records which depend on a given email template. Required Permissions: Read-Only Assets, Read-Write Assets

Request
path Parameters
id
required
integer <int32>

Id of the email template

query Parameters
offset
integer <int32>

Integer offset for paging

maxReturn
integer <int32>

Maximum number of channels to return. Max 200, default 20

Responses
200

OK

get/rest/asset/v1/emailTemplates/{id}/usedBy.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Emails

Email Controller

Get Email by Name

Returns an email records based on the given name. Required Permissions: Read-Only Assets, Read-Write Assets

Request
query Parameters
name
required
string

Name of the email

status
string

Status filter for draft or approved versions

Enum: "approved" "draft"
folder
string

JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'

Responses
200

OK

get/rest/asset/v1/email/byName.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Email By Id

Returns an email records by its id. Required Permissions: Read-Only Assets, Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

query Parameters
status
string

Status filter for draft or approved versions

Enum: "approved" "draft"
Responses
200

OK

get/rest/asset/v1/email/{id}.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Update Email Metadata

Updates the metadata of an email asset. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Request Body schema: application/x-www-form-urlencoded
required

updateEmailRequest

description
string

Description of the asset

name
string

Name of the Email

preHeader
string

Preheader text for the email

operational
boolean

Whether the email is operational. Operational emails bypass unsubscribe status. Defaults to false

published
boolean

Whether the email has been published to Sales Insight. Default false

textOnly
boolean

Setting to include text-only version of email when sent

webView
boolean

Whether the email has been enabled to allow the 'View as Web Page' when received

Responses
200

OK

post/rest/asset/v1/email/{id}.json
Request samples
application/x-www-form-urlencoded
description=string&name=string&preHeader=string&operational=true&published=true&textOnly=true&webView=true
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Approve Email Draft

Approves the current draft of an email. Required Permissions: Approve Assets

Request
path Parameters
id
required
integer <int32>

id

Responses
200

OK

post/rest/asset/v1/email/{id}/approveDraft.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Clone Email

Clones the target email. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Request Body schema: application/x-www-form-urlencoded
required

cloneEmailRequest

description
string

Description of the asset

required
object (Folder)

JSON representation of a folder

name
required
string

Name of the new email asset

operational
boolean

Whether the email is operational. Operational emails bypass unsubscribe status. Defaults to false

Responses
200

OK

post/rest/asset/v1/email/{id}/clone.json
Request samples
application/x-www-form-urlencoded
description=string&id=0&type=Folder&name=string&operational=true
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Email Content

Returns the content of the designated email. Required Permissions: Read-Only Assets, Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

query Parameters
status
string

Status filter for draft or approved versions

Enum: "approved" "draft"
Responses
200

OK

get/rest/asset/v1/email/{id}/content.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Update Email Content

Updates the content of an email. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Request Body schema: application/x-www-form-urlencoded
required

updateEmailRequest

object (EmailHeaderField)
object (EmailHeaderField)
object (EmailHeaderField)
object (EmailHeaderField)
Responses
200

OK

post/rest/asset/v1/email/{id}/content.json
Request samples
application/x-www-form-urlencoded
type=string&value=string&type=string&value=string&type=string&value=string&type=string&value=string
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Rearrange Email Modules

Rearranges the modules in an email. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Request Body schema: application/x-www-form-urlencoded

JSON array of module positions. Each position must be a JSON object with members 'index' and a 'moduleId'

string
Responses
200

OK

post/rest/asset/v1/email/{id}/content/rearrange.json
Request samples
application/x-www-form-urlencoded
string
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Update Email Content Section

Updates the content in the given section. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

htmlId
required
string

htmlId

Request Body schema: application/x-www-form-urlencoded
required

request

altText
string

Sets the value of the alt parameter for the resulting img element

externalUrl
string
height
integer <int32>

Overrides naitve height of the image. The resulting file will be resized to the given height

image
string

Multipart file that allows you to load an image from your computer

linkUrl
string
overWrite
boolean

Allows overwriting of the existing image content section

style
string

Sets the value of the style parameter for the content section

textValue
string
type
required
string

Type of content to set for the section.

Enum: "Text" "DynamicContent" "Snippet"
value
required
string

Value to set for the section. For type Text, the HTML content of the section. For type DynamicContent, the id of the segmentation to use for the content. For type Snippet, the id of the snippet to embed

videoUrl
string

Sets the Url of the video element. Videos must be either from YouTube or Vimeo

width
integer <int32>

Overrides native width of the image. The resulting file will be resized to the given width

Responses
200

OK

post/rest/asset/v1/email/{id}/content/{htmlId}.json
Request samples
application/x-www-form-urlencoded
altText=string&externalUrl=string&height=0&image=string&linkUrl=string&overWrite=true&style=string&textValue=string&type=Text&value=string&videoUrl=string&width=0
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Add Email Module

Adds a new module to an email, with the given id. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

moduleId
required
string

moduleId

query Parameters
name
required
string

Name of the module

index
required
integer <int32>

Index of the module. Determines the order of the module in the email.

Responses
200

OK

post/rest/asset/v1/email/{id}/content/{moduleId}/add.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Delete Module

Deletes the given module from the email. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

moduleId
required
string

moduleId

Responses
200

OK

post/rest/asset/v1/email/{id}/content/{moduleId}/delete.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Duplicate Email Module

Creates a copy of the designated module in an email. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

moduleId
required
string

moduleId

query Parameters
name
required
string

Name of the new module

Responses
200

OK

post/rest/asset/v1/email/{id}/content/{moduleId}/duplicate.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Rename Email Module

Renames a module. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

moduleId
required
string

moduleId

query Parameters
name
required
string

New module name

Responses
200

OK

post/rest/asset/v1/email/{id}/content/{moduleId}/rename.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Delete Email

Deletes the target email. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Responses
200

OK

post/rest/asset/v1/email/{id}/delete.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Discard Email Draft

Discards the current draft of an email. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Responses
200

OK

post/rest/asset/v1/email/{id}/discardDraft.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Email Dynamic Content

Retrieves the dyanmic content record for the given section. Required Permissions: Read-Only Assets, Read-Write Assets

Request
path Parameters
id
required
integer <int32>

Id of email

contentId
required
string

Id of email dynamic content section

query Parameters
status
string

Status filter for draft or approved versions

Enum: "approved" "draft"
Responses
200

OK

get/rest/asset/v1/email/{id}/dynamicContent/{contentId}.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Update Email Dynamic Content Section

Updates dynamic content in the given section. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

Id of email

contentId
required
string

Id of email dynamic content section

Request Body schema: application/x-www-form-urlencoded
required

Content properties

altText
string

Sets the value of the alt parameter for the resulting img element

externalUrl
string
height
integer <int32>

Overrides naitve height of the image. The resulting file will be resized to the given height

image
string

Multipart file that allows you to add an image from your computer

linkUrl
string
overWrite
boolean

Allows overwriting of the existing image content section

style
string

Sets the value of the style parameter for the content section

type
required
string

Type of content to set for the section.

Enum: "Text" "DynamicContent" "Snippet"
value
required
string

Value to set for the section. For type Text, the HTML content of the section. For type DynamicContent, the id of the segmentation to use for the content. For type Snippet, the id of the snippet to embed

videoUrl
string

Sets the Url of the video element. Videos must be either from YouTube or Vimeo

width
integer <int32>

Overrides native width of the image. The resulting file will be resized to the given width

Responses
200

OK

post/rest/asset/v1/email/{id}/dynamicContent/{contentId}.json
Request samples
application/x-www-form-urlencoded
altText=string&externalUrl=string&height=0&image=string&linkUrl=string&overWrite=true&style=string&type=Text&value=string&videoUrl=string&width=0
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Send Sample Email

Sends a sample email to the given email address. Leads may be impersonated to populate data for tokens and dynamic content. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

Id of the email

Request Body schema: application/x-www-form-urlencoded
required

sendSampleEmailRequest

emailAddress
required
string

Email address to receive sample email

leadId
string

Id of a lead to impersonate. Tokens and dynamic content will be populated as though it were sent to the lead.

textOnly
boolean

Whether to send to text only version along with the HTML version. Default false.

Responses
200

OK

post/rest/asset/v1/email/{id}/sendSample.json
Request samples
application/x-www-form-urlencoded
emailAddress=string&leadId=string&textOnly=true
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Unapprove Email

Unapproves the email and reverts it to a draft-only state. Required Permissions: Approve Assets

Request
path Parameters
id
required
integer <int32>

id

Responses
200

OK

post/rest/asset/v1/email/{id}/unapprove.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Update Email Variable

Updates the value of a given variable in an email. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

name
required
string

name

Request Body schema: application/x-www-form-urlencoded

updateVariableRequest

value
string

Value to update variable with

moduleId
string

Module that variable is associated with. Required for updating module variables. Not needed for global variables.

Responses
200

OK

post/rest/asset/v1/email/{id}/variable/{name}.json
Request samples
application/x-www-form-urlencoded
value=string&moduleId=string
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Email Variables

Returns a list of the available variables in an email. Required Permissions: Read-Only Assets, Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Responses
200

OK

get/rest/asset/v1/email/{id}/variables.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Email CC Fields

Returns the set of fields enabled for Email CC in the target instance. Required Permissions: Read-Only Assets, Read-Write Assets

Responses
200

OK

get/rest/asset/v1/email/ccFields.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Emails

Returns a list of emails matching the given filter parameters. Required Permissions: Read-Only Assets, Read-Write Assets

Request
query Parameters
status
string

Status filter for draft or approved versions

Enum: "approved" "draft"
folder
string

JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'

offset
integer <int32>

Integer offset for paging

maxReturn
integer <int32>

Maximum number of emails to return. Max 200, default 20

earliestUpdatedAt
string

Exclude emails prior to this date. Must be valid ISO-8601 string. See Datetime field type description.

latestUpdatedAt
string

Exclude emails after this date. Must be valid ISO-8601 string. See Datetime field type description.

Responses
200

OK

get/rest/asset/v1/emails.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Create Email

Creates a new email asset. Required Permissions: Read-Write Assets

Request
Request Body schema: application/x-www-form-urlencoded
required

createEmailRequest

description
string

Description of the asset

required
object (Folder)

JSON representation of a folder

fromEmail
required
string

From-address of the Email

fromName
required
string

From-name of the Email

name
required
string

Name of the email

operational
boolean

Whether the email is operational. Operational emails bypass unsubscribe status. Defaults to false

replyEmail
required
string

Reply-To address of the Email

subject
required
string

Subject Line of the Email

template
required
integer <int32>

Id of the parent template

textOnly
string

Setting to include text-only version of email when sent

Responses
200

OK

post/rest/asset/v1/emails.json
Request samples
application/x-www-form-urlencoded
description=string&id=0&type=Folder&fromEmail=string&fromName=string&name=string&operational=true&replyEmail=string&subject=string&template=0&textOnly=string
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Email Full Content

Returns the serialized HTML version of the email. Required Permissions: Read-Only Assets, Read-Write Assets. If leadId is passed in the request: Read-Only Lead, Read-Write Lead.

Request
path Parameters
id
required
integer <int32>

Id of the email

query Parameters
status
string

Status filter for draft or approved versions. Defaults to approved if asset is approved, draft if not.

Enum: "approved" "draft"
leadId
integer <int32>

The lead id to impersonate. Email is rendered as though it was received by this lead.

type
string

Email content type to return. Default is HTML.

Enum: "Text" "HTML"
Responses
200

OK

get/rest/asset/v1/email/{id}/fullContent.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Update Email Full Content

Replaces the HTML of an Email that has had its relationship broken from its template. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

Id of the email

Request Body schema: multipart/form-data
required

Content is multipart file parameter

content
required
string

Multipart file. File containing HTML document to update with. File cannot include JavaScript or script tags.

Responses
200

OK

post/rest/asset/v1/email/{id}/fullContent.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

File Contents

File Content Controller

Update File Content

Replaces the current content of the file with the included payload. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

Id for file in database

Request Body schema: multipart/form-data
required

request

file
required
string

Multipart file. Content of the file.

id
required
integer <int32>

Id of the file

Responses
200

OK

post/rest/asset/v1/file/{id}/content.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Files

File Controller

Get File by Name

Returns files records for the given name. Required Permissions: Read-Only Assets, Read-Write Assets

Request
query Parameters
name
required
string

Name of the file

Responses
200

OK

get/rest/asset/v1/file/byName.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get File by Id

Returns the file record for the given id. Required Permissions: Read-Only Assets, Read-Write Assets

Request
path Parameters
id
required
integer <int32>

Id for file in database

Responses
200

OK

get/rest/asset/v1/file/{id}.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Files

Returns the files from the given folder. Required Permissions: Read-Only Assets, Read-Write Assets

Request
query Parameters
folder
string

JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'

offset
integer <int32>

Integer offset for paging. Default 0

maxReturn
integer <int32>

Maximum number of files to return. Max 200, default 20

Responses
200

OK

get/rest/asset/v1/files.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Create File

Creates a new file from the included payload. Required Permissions: Read-Write Assets

Request
Request Body schema: multipart/form-data
required

createFileRequest

description
string

Description of the asset

file
required
string

Multipart file. Content of the file.

required
object (Folder)

JSON representation of a folder

insertOnly
boolean

Whether the calls hould fail if there is already an existing file with the same name

name
required
string

Name of the File

Responses
200

OK

post/rest/asset/v1/files.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Folders

Folder Controller

Get Folder by Name

Returns a folder record for the given name. Required Permissions: Read-Only Assets, Read-Write Assets

Request
query Parameters
name
required
string

Name of the folder. Not applicable for Programs

type
string

Type of folder. 'Folder' or 'Program'

root
string

Parent folder reference

workSpace
string

Name of the workspace

Responses
200

OK

get/rest/asset/v1/folder/byName.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Folder by Id

Returns the folder record with the given id. Required Permissions: Read-Only Assets, Read-Write Assets

Request
path Parameters
id
required
integer <int32>

Id of the folder to retrieve

query Parameters
type
required
string
Default: "Folder"

Type of folder. 'Folder' or 'Program'

Enum: "Folder" "Program"
Responses
200

OK

get/rest/asset/v1/folder/{id}.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Update Folder Metadata

Updates the metadata for a given folder. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

Id of the folder to update

Request Body schema: application/x-www-form-urlencoded
required

updateFolderRequest

description
string

Description of the asset

isArchive
boolean

Whether the folder is archived or not. Toggling this value will change the archival status of the folder

name
string

Name of the Folder

type
required
string

Type of folder. 'Folder' or 'Program'

Enum: "Folder" "Program"
Responses
200

OK

post/rest/asset/v1/folder/{id}.json
Request samples
application/x-www-form-urlencoded
description=string&isArchive=true&name=string&type=Folder
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Folder Contents

Returns records for the contents of a given folder. Required Permissions: Read-Only Assets, Read-Write Assets

Request
path Parameters
id
required
integer <int32>

Id of the folder to retrieve

query Parameters
maxReturn
integer <int32>

Maximum number of channels to return. Max 200, default 20

offset
integer <int32>

Integer offset for paging

type
required
string

Type of folder. 'Folder' or 'Program'. Default is 'Folder'

Enum: "Folder" "Program"
Responses
200

OK

get/rest/asset/v1/folder/{id}/content.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Delete Folder

Deletes the designated folder. Deletion will fail if the folder has content. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

Id of the folder to delete

Request Body schema: application/x-www-form-urlencoded
required
type
required
string
Default: "Folder"

type

Enum: "Program" "Folder"
Responses
200

OK

post/rest/asset/v1/folder/{id}/delete.json
Request samples
application/x-www-form-urlencoded
type=Program
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Folders

Retrieves child folders from within a given root folder. Required Permissions: Read-Only Assets, Read-Write Assets

Request
query Parameters
root
string

Parent folder reference

maxDepth
integer <int32>

Maximum folder depth to traverse, Default 2

maxReturn
integer <int32>

Maximum number of folders to return. Default 20, maximum 200

offset
integer <int32>

Integer offset for paging. Default 0

workSpace
string

Name of the workspace

Responses
200

OK

get/rest/asset/v1/folders.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Create Folder

Creates a new folder. Required Permissions: Read-Write Assets

Request
Request Body schema: application/x-www-form-urlencoded
required

createFolderRequest

description
string

Description of the asset

name
required
string

Name of the Folder

required
object (Folder)

JSON representation of a folder

Responses
200

OK

post/rest/asset/v1/folders.json
Request samples
application/x-www-form-urlencoded
description=string&name=string&id=0&type=Folder
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Form Fields

Form Field Controller

Get Available Form Fields

Retrieves a list of all valid fields for use in forms. Required Permissions: Read-Only Assets, Read-Write Assets

Request
query Parameters
maxReturn
integer <int32>

Maximum number of fields to return. Max 200, default 20

offset
integer <int32>

Integer offset for paging

Responses
200

OK

get/rest/asset/v1/form/fields.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Available Form Program Member Fields

Retrieves a list of all valid Program Member fields for use in forms. Required Permissions: Read-Only Assets, Read-Write Assets

Request
query Parameters
maxReturn
integer <int32>

Maximum number of fields to return. Max 200, default 20

offset
integer <int32>

Integer offset for paging

Responses
200

OK

get/rest/asset/v1/form/programMemberFields.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Add Form Field Visibility Rules

Adds a visibility rule to the target form field. Required Permissions: Read-Write Assets

Request
path Parameters
formId
required
integer <int32>

formId

fieldId
required
string

fieldId

Request Body schema: application/x-www-form-urlencoded
required

addFormFieldVisibilityRequest

object (FormFieldVisibilityRequest)
Responses
200

OK

post/rest/asset/v1/form/{formId}/field/{fieldId}/visibility.json
Request samples
application/x-www-form-urlencoded
ruleType=show&rules=%5Bobject%20Object%5D
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Update Form Field

Updates the configuration for that target field. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

fieldId
required
string

fieldId

Request Body schema: application/x-www-form-urlencoded
required

updateFormFieldRequest

blankFields
integer <int32>

Number of blank fields to show when progressive profiling is enabled

defaultValue
string

Optional default value for the field

fieldType
string

Type of field

fieldWidth
integer <int32>

Width of the input or select element

formPrefill
boolean

Whether the field should prefill. Default true

isSensitive
boolean

Whether the field is marked as sensitive. Default false

hintText
string

Hint text for the field

initiallyChecked
boolean

Whether the field should be checked upon loading. Default false

instructions
string

Instructions for the field

label
string

Label of the field

labelToRight
boolean

Whether the field label should be displayed to the right of the input/select element. Default false

labelWidth
integer <int32>

Width of the field label element

maskInput
string

Optional input mask for the field

maxLength
integer <int32>

Maximum length for text type fields

maxValue
number <float>

Maximum value accepted by the field

minValue
number <float>

Minimum value accepted by the field

multiSelect
boolean

Whether the field should allow multiple selections. Default false

required
boolean

Whether the field is required to submit the form. Default false

validationMessage
string

Validation message to display on failed validation

values
string

Array of JSON objects that contain field attributes. Only for select-field types. Example: values=[{'label':'Select...','value':'','isDefault':true,'selected':true}, {'label':'MR','value':'Mr'}, {'label':'MS','value':'Ms'}, {'label':'MRS','value':'Mrs'}, {'label':'DR','value':'Dr'}, {'label':'PROF','value':'Prof'}]

visibleLines
integer <int32>

Number of lines to display for the field element

Responses
200

OK

post/rest/asset/v1/form/{id}/field/{fieldId}.json
Request samples
application/x-www-form-urlencoded
blankFields=0&defaultValue=string&fieldType=string&fieldWidth=0&formPrefill=true&isSensitive=true&hintText=string&initiallyChecked=true&instructions=string&label=string&labelToRight=true&labelWidth=0&maskInput=string&maxLength=0&maxValue=0&minValue=0&multiSelect=true&required=true&validationMessage=string&values=string&visibleLines=0
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Delete Form Field

Deletes a field from a form. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

fieldId
required
string

fieldId

Responses
200

OK

post/rest/asset/v1/form/{id}/field/{fieldId}/delete.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Add Fieldset to Form

Adds a field set to the target form. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Request Body schema: application/x-www-form-urlencoded
required

addFormFieldSetRequest

label
required
string

Label of the fieldset

Responses
200

OK

post/rest/asset/v1/form/{id}/fieldSet.json
Request samples
application/x-www-form-urlencoded
label=string
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Delete Field from Fieldset

Removes the target field from the fieldset. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

fieldSetId
required
string

fieldSetId

fieldId
required
string

fieldId

Responses
200

OK

post/rest/asset/v1/form/{id}/fieldSet/{fieldSetId}/field/{fieldId}/delete.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Fields for Form

Retrieves the list of fields in the target form. Required Permissions: Read-Only Assets, Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

query Parameters
status
string

Status filter for draft or approved versions

Enum: "approved" "draft"
Responses
200

OK

get/rest/asset/v1/form/{id}/fields.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Add Field to Form

Adds a field to a form. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Request Body schema: application/x-www-form-urlencoded
required

addFormFieldSetRequest

blankFields
integer <int32>

Number of blank fields to show when progressive profiling is enabled

defaultValue
string

Optional default value for the field

fieldId
required
string

Id of the field

fieldWidth
integer <int32>

Width of the input or select element

formPrefill
boolean

Whether the field should prefill. Default true

isSensitive
boolean

Whether the field is marked as sensitive. Default false

hintText
string

Hint text for the field

initiallyChecked
boolean

Whether the field should be checked upon loading. Default false

instructions
string

Instructions for the field

label
string

Label of the field

labelToRight
boolean

Whether the field label should be displayed to the right of the input/select element. Default false

labelWidth
integer <int32>

Width of the field label element

maskInput
string

Optional input mask for the field

maxLength
integer <int32>

Maximum length for text type fields

maxValue
number <float>

Maximum value accepted by the field

minValue
number <float>

Minimum value accepted by the field

multiSelect
boolean

Whether the field should allow multiple selections. Default false

required
boolean

Whether the field is required to submit the form. Default false

validationMessage
string

Validation message to display on failed validation

values
string

Comma-separated list of accepted values for the field. Only for select-field types

visibleLines
integer <int32>

Number of lines to display for the field element

Responses
200

OK

post/rest/asset/v1/form/{id}/fields.json
Request samples
application/x-www-form-urlencoded
blankFields=0&defaultValue=string&fieldId=string&fieldWidth=0&formPrefill=true&isSensitive=true&hintText=string&initiallyChecked=true&instructions=string&label=string&labelToRight=true&labelWidth=0&maskInput=string&maxLength=0&maxValue=0&minValue=0&multiSelect=true&required=true&validationMessage=string&values=string&visibleLines=0
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Update Field Positions

Reorders the list of fields in a form. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Request Body schema: application/x-www-form-urlencoded

reArrangeRequest

Array of objects (UpdateFieldPosition)
Responses
200

OK

post/rest/asset/v1/form/{id}/reArrange.json
Request samples
application/x-www-form-urlencoded
positions=%5Bobject%20Object%5D
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Add Rich Text Field

Adds a rich-text type field to the form. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Request Body schema: application/x-www-form-urlencoded
required

addRichTextRequest

text
required
string

Multipart file. HTML Content for the rich text field.

Responses
200

OK

post/rest/asset/v1/form/{id}/richText.json
Request samples
application/x-www-form-urlencoded
text=string
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Forms

Form Controller

Get Form by Name

Retrieves a form record by its name. Required Permissions: Read-Only Assets, Read-Write Assets

Request
query Parameters
name
required
string

Name of the form

status
string

Status filter for draft or approved versions

Enum: "approved" "draft"
folder
string

JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'

Responses
200

OK

get/rest/asset/v1/form/byName.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Form By Id

Retrieves a form record by its id. Required Permissions: Read-Only Assets, Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

query Parameters
status
string

Status filter for draft or approved versions

Enum: "approved" "draft"
Responses
200

OK

get/rest/asset/v1/form/{id}.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Update Form Metadata

Updates the metadata of the target form. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Request Body schema: application/x-www-form-urlencoded
required

updateFormMetaDataRequest

customCss
string

Custom CSS to apply to the form

description
string

Description of the form

fontFamily
string

font-family property for the form

fontSize
string

font-size property of the form

object (FormKnownVisitorDTO)
labelPosition
string

Default positioning of labels.

language
string

Language of the form

locale
string

Locale of the form

name
string

Name of the form

progressiveProfiling
boolean

Whether progressive profiling is enabled for the form

theme
string

CSS theme for the form to use

Responses
200

OK

post/rest/asset/v1/form/{id}.json
Request samples
application/x-www-form-urlencoded
customCss=string&description=string&fontFamily=string&fontSize=string&template=string&type=string&labelPosition=string&language=string&locale=string&name=string&progressiveProfiling=true&theme=string
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Approve Form Draft

Approves the current draft of the form. This will delete the current approved version of the form. Required Permissions: Approve Assets

Request
path Parameters
id
required
integer <int32>

id

Responses
200

OK

post/rest/asset/v1/form/{id}/approveDraft.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Clone Form

Clones the target form. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Request Body schema: application/x-www-form-urlencoded

cloneFormRequest

name
required
string

Name for the cloned form

required
object (Folder)

JSON representation of a folder

description
string

Description of the cloned form

Responses
200

OK

post/rest/asset/v1/form/{id}/clone.json
Request samples
application/x-www-form-urlencoded
name=string&id=0&type=Folder&description=string
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Delete Form

Deletes the target form. Forms which are in use by landing pages may not be deleted until they are removed from all landing pages. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Responses
200

OK

post/rest/asset/v1/form/{id}/delete.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Discard Form Draft

Discards the current draft of the form. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Responses
200

OK

post/rest/asset/v1/form/{id}/discardDraft.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Update Submit Button

Updates the submit button configuration for the target form. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Request Body schema: application/x-www-form-urlencoded
required

submitButtonRequest

buttonPosition
integer <int32>

Location in pixels of the button relative to the left of the form

buttonStyle
string

Style of the button

label
string

Label text of the button

waitingLabel
string

Waiting text of the button

Responses
200

OK

post/rest/asset/v1/form/{id}/submitButton.json
Request samples
application/x-www-form-urlencoded
buttonPosition=0&buttonStyle=string&label=string&waitingLabel=string
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Thank You Page by Form Id

Returns the thank you page configuration for a given form. Required Permissions: Read-Only Assets, Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

query Parameters
status
string

Status filter for draft or approved versions

Enum: "approved" "draft"
Responses
200

OK

get/rest/asset/v1/form/{id}/thankYouPage.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Update Thank You Page

Updates the thank you page configuration for a given form. This update is destructive and the resulting draft will not have any memory of the previous configuration. Required Permissions: Read-Only Assets, Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Request Body schema: application/x-www-form-urlencoded
required

thankYouPageRequest

Array of objects (ThankYouPageRequest)

JSON array of followup rules

Responses
200

OK

post/rest/asset/v1/form/{id}/thankYouPage.json
Request samples
application/x-www-form-urlencoded
thankyou=%5Bobject%20Object%5D
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Forms

Retrieves a list of accessible form records from the target instance. Required Permissions: Read-Only Assets, Read-Write Assets

Request
query Parameters
status
string

Status filter for draft or approved versions

Enum: "approved" "draft"
folder
string

JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'

maxReturn
string

Maximum number of channels to return. Max 200, default 20

offset
string

Integer offset for paging

Responses
200

OK

get/rest/asset/v1/forms.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Create Form

Creates a new form. Required Permissions: Read-Write Assets

Request
Request Body schema: application/x-www-form-urlencoded
required

createFormRequest

description
string

Description of the form

required
object (Folder)

JSON representation of a folder

fontFamily
string

font-family property for the form

fontSize
string

font-size property of the form

object (FormKnownVisitorDTO)
labelPosition
string

Default positioning of labels.

language
string

Language of the form

locale
string

Locale of the form

name
string

Name of the form

progressiveProfiling
boolean

Whether progressive profiling is enabled for the form

theme
string

CSS theme for the form to use

Responses
200

OK

post/rest/asset/v1/forms.json
Request samples
application/x-www-form-urlencoded
description=string&id=0&type=Folder&fontFamily=string&fontSize=string&template=string&type=string&labelPosition=string&language=string&locale=string&name=string&progressiveProfiling=true&theme=string
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Form Used By

Returns a list of asset records which depend on a given form. Required Permissions: Read-Only Assets, Read-Write Assets

Request
path Parameters
id
required
integer <int32>

Id of the form

query Parameters
offset
integer <int32>

Integer offset for paging

maxReturn
integer <int32>

Maximum number of assets to return. Max 200, default 20

Responses
200

OK

get/rest/asset/v1/form/{id}/usedBy.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Landing Page Content

Landing Page Content Controller

Get Landing Page Content

Retrieves the list of content sections in the target landing page. Required Permissions: Read-Only Assets, Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

query Parameters
status
string

Status filter for draft or approved versions

Enum: "approved" "draft"
Responses
200

OK

get/rest/asset/v1/landingPage/{id}/content.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Add Landing Page Content Section

Adds a content section to the target landing page. Parameters must be sent as application/x-www-form-urlencoded (not JSON). Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Request Body schema: application/x-www-form-urlencoded
required

request

backgroundColor
string

background-color property of the HTML section

borderColor
string

border-color property of the HTML section

borderStyle
string

border-style property of the HTML section

borderWidth
string

border-width property of the HTML section

contentId
required
string

Id of the content section. Also the HTML id of the section.

height
string

height property of the HTML section

hideDesktop
boolean

Hide the section when displayed on a desktop browser. Default false

hideMobile
boolean

Hide the section when displayed on a mobile browser. Default false

imageOpenNewWindow
string
left
string

left property of the HTML section

linkUrl
string

URL parameter of a link type section

opacity
string

opacity property of the HTML section

top
string

top property of the HTML section

type
required
string

Type of content section

Enum: "Image" "Form" "Rectangle" "Snippet" "RichText" "HTML"
value
string

Type of content section

width
string

width property of the HTML section

zIndex
string

z-index property of the HTML section

Responses
200

OK

post/rest/asset/v1/landingPage/{id}/content.json
Request samples
application/x-www-form-urlencoded
backgroundColor=string&borderColor=string&borderStyle=string&borderWidth=string&contentId=string&height=string&hideDesktop=true&hideMobile=true&imageOpenNewWindow=string&left=string&linkUrl=string&opacity=string&top=string&type=Image&value=string&width=string&zIndex=string
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Update Landing Page Content Section

Updates a content section the landing page. Parameters must be sent as application/x-www-form-urlencoded (not JSON). Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

Id of landing page

contentId
required
string

Id of landing page content section

Request Body schema: application/x-www-form-urlencoded
required

Content properties

backgroundColor
string

background-color property of the HTML section

borderColor
string

border-color property of the HTML section

borderStyle
string

border-style property of the HTML section

borderWidth
string

border-width property of the HTML section

height
string

height property of the HTML section

hideDesktop
boolean

Hide the section when displayed on a desktop browser. Default false

hideMobile
boolean

Hide the section when displayed on a mobile browser. Default false

imageOpenNewWindow
string
index
integer <int32>

Index of the content section. Determines the order of the section in the landing page

left
string

left property of the HTML section

linkUrl
string

URL parameter of a link type section

opacity
string

opacity property of the HTML section

top
string

top property of the HTML section

type
required
string

Type of content section

Enum: "Image" "Form" "Rectangle" "Snippet" "RichText" "HTML" "DynamicContent"
value
string

Type of content section

width
string

width property of the HTML section

zIndex
string

z-index property of the HTML section

Responses
200

OK

post/rest/asset/v1/landingPage/{id}/content/{contentId}.json
Request samples
application/x-www-form-urlencoded
backgroundColor=string&borderColor=string&borderStyle=string&borderWidth=string&height=string&hideDesktop=true&hideMobile=true&imageOpenNewWindow=string&index=0&left=string&linkUrl=string&opacity=string&top=string&type=Image&value=string&width=string&zIndex=string
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Delete Landing Page Content Section

Removes the target content section from the parent landing page. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

Id of landing page

contentId
required
string

Id of landing page content section

Responses
200

OK

post/rest/asset/v1/landingPage/{id}/content/{contentId}/delete.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Landing Page Dynamic Content

Retrieves the dynamic content from the target section. Required Permissions: Read-Only Assets, Read-Write Assets

Request
path Parameters
id
required
integer <int32>

Id of landing page

contentId
required
string

Id of landing page dynamic content section

Responses
200

OK

get/rest/asset/v1/landingPage/{id}/dynamicContent/{contentId}.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Update Landing Page Dynamic Content Section

Updates the content of the target dynamic content section. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

Id of the landing page

contentId
required
string

Id of the landing page dynamic content

Request Body schema: application/x-www-form-urlencoded

Dynamic content properties

backgroundColor
string

background-color property of the HTML section

borderColor
string

border-color property of the HTML section

borderStyle
string

border-style property of the HTML section

borderWidth
string

border-width property of the HTML section

height
string

height property of the HTML section

hideDesktop
boolean

Hide the section when displayed on a desktop browser. Default false

hideMobile
boolean

Hide the section when displayed on a mobile browser. Default false

imageOpenNewWindow
string
left
string

left property of the HTML section

linkUrl
string

URL parameter of a link type section

opacity
string

opacity property of the HTML section

segment
string

Name of the segment to display content section for

top
string

top property of the HTML section

type
string

Type of content section

value
string

Type of content section

width
string

width property of the HTML section

zIndex
string

z-index property of the HTML section

Responses
200

OK

post/rest/asset/v1/landingPage/{id}/dynamicContent/{contentId}.json
Request samples
application/x-www-form-urlencoded
backgroundColor=string&borderColor=string&borderStyle=string&borderWidth=string&height=string&hideDesktop=true&hideMobile=true&imageOpenNewWindow=string&left=string&linkUrl=string&opacity=string&segment=string&top=string&type=string&value=string&width=string&zIndex=string
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Landing Pages

Landing Page Controller

Get Landing Page by Name

Returns the landing page record for the given name. Required Permissions: Read-Only Assets, Read-Write Assets

Request
query Parameters
name
required
string

Name of the landing page

status
string

Status filter for draft or approved versions

Enum: "approved" "draft"
maxReturn
integer <int32>

Maximum number of channels to return. Max 200, default 20

offset
integer <int32>

Integer offset for paging

Responses
200

OK

get/rest/asset/v1/landingPage/byName.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Landing Page by Id

Returns the landing record for the given id. Required Permissions: Read-Only Assets, Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

query Parameters
status
string

Status filter for draft or approved versions

Enum: "approved" "draft"
Responses
200

OK

get/rest/asset/v1/landingPage/{id}.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Update Landing Page Metadata

Updates the metadata for the targe landing page. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Request Body schema: application/x-www-form-urlencoded
required

updateLandingPageRequest

customHeadHTML
string

Any custom HTML to embed in the tag of the page

description
string

Description of the asset

facebookOgTags
string

Any OpenGraph meta tags to apply to the page

keywords
string
metaTagsDescription
string

Meta description property of the page

mobileEnabled
boolean

Whether the page has mobile viewing enabled. Free-form pages only. Default false

name
string

Name of the landing page

robots
string

Robots directives to apply to the pages meta tags

styleOverRide
string

Additional CSS styles to append to the landing page

title
string

Title element of the landing page

urlPageName
string

URL path of the page. Derived from the name field if unset

Responses
200

OK

post/rest/asset/v1/landingPage/{id}.json
Request samples
application/x-www-form-urlencoded
customHeadHTML=string&description=string&facebookOgTags=string&keywords=string&metaTagsDescription=string&mobileEnabled=true&name=string&robots=string&styleOverRide=string&title=string&urlPageName=string
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Approve Landing Page Draft

Approves the current draft of the landing page. Required Permissions: Approve Assets

Request
path Parameters
id
required
integer <int32>

id

Responses
200

OK

post/rest/asset/v1/landingPage/{id}/approveDraft.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Clone Landing Page

Clones the target landing page. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Request Body schema: application/x-www-form-urlencoded
required

cloneLandingPageRequest

description
string

Description of the asset

required
object (Folder)

JSON representation of a folder

name
required
string

Name of the landing page

template
integer <int32>

Id of the template used

Responses
200

OK

post/rest/asset/v1/landingPage/{id}/clone.json
Request samples
application/x-www-form-urlencoded
description=string&id=0&type=Folder&name=string&template=0
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Delete Landing Page

Deletes the target landing page. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Responses
200

OK

post/rest/asset/v1/landingPage/{id}/delete.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Discard Landing Page Draft

Discards the current draft of the landing page. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Responses
200

OK

post/rest/asset/v1/landingPage/{id}/discardDraft.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Unapprove Landing Page

Unapproves the landing page, reverting it to a draft-only state. Required Permissions: Approve Assets

Request
path Parameters
id
required
integer <int32>

id

Responses
200

OK

post/rest/asset/v1/landingPage/{id}/unapprove.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Update Landing Page Variable

Updates the value of the given variable. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

variableId
required
string

variableId

query Parameters
value
required
integer <int32>

New value of the variable

Responses
200

OK

post/rest/asset/v1/landingPage/{id}/variable/{variableId}.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Landing Page Variables

Request
path Parameters
id
required
integer <int32>

Id of the landing page

query Parameters
status
string

Status filter for draft or approved versions

Enum: "approved" "draft"
Responses
200

OK

get/rest/asset/v1/landingPage/{id}/variables.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Landing Pages

Retrieves a list of accessible landing pages from the target instance. Required Permissions: Read-Only Assets, Read-Write Assets

Request
query Parameters
status
string

Status filter for draft or approved versions

Enum: "approved" "draft"
maxReturn
integer <int32>

Maximum number of landing pages to return. Max 200, default 20

offset
integer <int32>

Integer offset for paging

folder
string

JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'

Responses
200

OK

get/rest/asset/v1/landingPages.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Create Landing Page

Creates a new landing page. Required Permissions: Read-Write Assets

Request
Request Body schema: application/x-www-form-urlencoded
required

createLandingPageRequest

customHeadHTML
string

Any custom HTML to embed in the tag of the page

description
string

Description of the asset

facebookOgTags
string

Any OpenGraph meta tags to apply to the page

required
object (Folder)

JSON representation of a folder

keywords
string
mobileEnabled
boolean

Whether the page has mobile viewing enabled. Free-form pages only. Default false

name
required
string

Name of the landing page

prefillForm
boolean

Boolean to toggle whether forms embedded in the page will prefill. Default false

robots
string

Robots directives to apply to the pages meta tags

template
required
integer <int32>

Id of the template used

title
string

Title element of the landing page

urlPageName
string

URL path of the page. Derived from the name field if unset

workspace
string

Name of the workspace

Responses
200

OK

post/rest/asset/v1/landingPages.json
Request samples
application/x-www-form-urlencoded
customHeadHTML=string&description=string&facebookOgTags=string&id=0&type=Folder&keywords=string&mobileEnabled=true&name=string&prefillForm=true&robots=string&template=0&title=string&urlPageName=string&workspace=string
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Landing Page Full Content

Returns the serialized HTML version of the landing page. Required Permissions: Read-Only Assets, Read-Write Assets. If leadId is passed in the request: Read-Only Lead, Read-Write Lead.

Request
path Parameters
id
required
integer <int32>

Id of the landing page.

query Parameters
leadId
integer <int32>

The lead id to impersonate. Landing page is rendered as though it was viewed by this lead.

segmentation
string

JSON array of of segmentations. Each segmentation must be a JSON object with members 'segmentationId', and 'segmentId'.
Example: [{"segmentationId":1030,"segmentId":1103}]

Responses
200

OK

get/rest/asset/v1/landingPage/{id}/fullContent.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Landing Page Redirect Rules

Landing Page Redirect Rule Controller

Get Landing Page Redirect Rules

Retrieves a list of landing page redirect rules from the target instance. Required Permissions: Read Only Redirect Rules, Read Write Redirect Rules

Request
query Parameters
maxReturn
integer <int32>

Maximum number of landing page redirect rules to return. Max 200, default 20

offset
integer <int32>

Integer offset for paging

redirectTolandingPageId
string

Landing page id of landing page to redirect to

redirectToPath
string

Path of landing page to redirect to

earliestUpdatedAt
string

Exclude landing page redirect rules prior to this date. Must be valid ISO-8601 string. See Datetime field type description.

latestUpdatedAt
string

Exclude landing page redirect rules after this date. Must be valid ISO-8601 string. See Datetime field type description.

Responses
200

OK

get/rest/asset/v1/redirectRules.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Create Landing Page Redirect Rule

Create a new landing page redirect rule. Required Permissions: Read Write Redirect Rules

Request
Request Body schema: application/x-www-form-urlencoded
required

createLandingPageRedirectRuleRequest

hostname
required
string

The hostname for the landing pages. Branding domain or alias. Max 255 characters

required
object (RedirectFrom)

JSON representation of 'from' redirect landing page rule

required
object (RedirectTo)

JSON representation of 'to' redirect landing page rule

Responses
200

OK

post/rest/asset/v1/redirectRules.json
Request samples
application/x-www-form-urlencoded
hostname=string&type=landingPageId&value=string&type=landingPageId&value=string
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Landing Page Redirect Rule by Id

Retrieves the landing page redirect rule record. Required Permissions: Read Only Redirect Rules, Read Write Redirect Rules

Request
path Parameters
id
required
integer <int32>

Id of landing page redirect rule

Responses
200

OK

get/rest/asset/v1/redirectRule/{id}.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Update Landing Page Redirect Rule

Update an existing landing page redirect rule. Required Permissions: Read Write Redirect Rules

Request
path Parameters
id
required
integer <int32>

Id of landing page redirect rule

Request Body schema: application/x-www-form-urlencoded
required

updateLandingPageRedirectRuleRequest

hostname
string

The hostname for the landing pages. Branding domain or alias. Max 255 characters

object (RedirectFrom)

JSON representation of 'from' redirect landing page rule

object (RedirectTo)

JSON representation of 'to' redirect landing page rule

Responses
200

OK

post/rest/asset/v1/redirectRule/{id}.json
Request samples
application/x-www-form-urlencoded
hostname=string&type=landingPageId&value=string&type=landingPageId&value=string
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Delete Landing Page Redirect Rule

Delete a landing page redirect rule. Required Permissions: Read Write Redirect Rules

Request
path Parameters
id
required
integer <int32>

Id of landing page redirect rule

Responses
200

OK

post/rest/asset/v1/redirectRule/{id}/delete.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Landing Page Domains

Retrieves a list of landing page domain and domain aliases. Required Permissions: Read Only Redirect Rules, Read Write Redirect Rules

Request
query Parameters
maxReturn
integer <int32>

Maximum number of landing page domains and domain aliases to return. Max 200, default 20

offset
integer <int32>

Integer offset for paging

Responses
200

OK

get/rest/asset/v1/landingPageDomains.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Landing Page Templates

Landing Page Templates

Get Landing Page Template by Name

Retrieves the landing page template record for the given name. Required Permissions: Read-Only Assets, Read-Write Assets

Request
query Parameters
name
required
string

Name of the landing page template

Responses
200

OK

get/rest/asset/v1/landingPageTemplate/byName.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Landing Page Template by Id

Retrieves the record for the target landing page template. Required Permissions: Read-Only Assets, Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

query Parameters
status
string

Status filter for draft or approved versions

Enum: "approved" "draft"
Responses
200

OK

get/rest/asset/v1/landingPageTemplate/{id}.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Update Landing Page Template Metadata

Updates the metadata for the target landing page template. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Request Body schema: application/x-www-form-urlencoded
required

updateLpTemplateRequest

description
string

Description of the landing page template

enableMunchkin
boolean

Whether to enable munchkin on the derived pages. Defaults to true

name
string

Name of the landing page template

Responses
200

OK

post/rest/asset/v1/landingPageTemplate/{id}.json
Request samples
application/x-www-form-urlencoded
description=string&enableMunchkin=true&name=string
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Approve Landing Page Template Draft

Approves the current landing page template draft. This will delete the current approved version of the template if there is one. Required Permissions: Approve Assets

Request
path Parameters
id
required
integer <int32>

id

Responses
200

OK

post/rest/asset/v1/landingPageTemplate/{id}/approveDraft.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Clone Landing Page Template

Clones the target landing page template. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Request Body schema: application/x-www-form-urlencoded
required

cloneLpTemplateRequest

description
string

Description of the landing page template

required
object (Folder)

JSON representation of a folder

name
required
string

Name of the landing page template

Responses
200

OK

post/rest/asset/v1/landingPageTemplate/{id}/clone.json
Request samples
application/x-www-form-urlencoded
description=string&id=0&type=Folder&name=string
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Landing Page Template Content

Retrieves the content of the target landing page. Required Permissions: Read-Only Assets, Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

query Parameters
status
string

Status filter for draft or approved versions

Enum: "approved" "draft"
Responses
200

OK

get/rest/asset/v1/landingPageTemplate/{id}/content.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Update Landing Page Template Content

Updates the content for the target landing page template. This update is destructive for the draft version of the template. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Request Body schema: multipart/form-data
required
content
required
string

content

Responses
200

OK

post/rest/asset/v1/landingPageTemplate/{id}/content.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Delete Landing Page Template

Deletes the target landing page template. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Responses
200

OK

post/rest/asset/v1/landingPageTemplate/{id}/delete.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Discard Landing Page Template Draft

Discrads the current draft of the landing page template. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Responses
200

OK

post/rest/asset/v1/landingPageTemplate/{id}/discardDraft.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Unapprove Landing Page Template

Unapproves the landing page template and reverts it to a draft-only state. Required Permissions: Approve Assets

Request
path Parameters
id
required
integer <int32>

id

Responses
200

OK

post/rest/asset/v1/landingPageTemplate/{id}/unapprove.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Landing Page Templates

Retrieves the list of accessible landing page templates from the target instance. Required Permissions: Read-Only Assets, Read-Write Assets

Request
query Parameters
maxReturn
integer <int32>

Maximum number of channels to return. Max 200, default 20

offset
integer <int32>

Integer offset for paging

status
string

Status filter for draft or approved versions

Enum: "approved" "draft"
folder
string

JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'

Responses
200

OK

get/rest/asset/v1/landingPageTemplates.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Create Landing Page Template

Creates a new landing page template. Required Permissions: Read-Write Assets

Request
Request Body schema: application/x-www-form-urlencoded
required

createLpTemplateRequest

description
string

Description of the landing page template

enableMunchkin
boolean

Whether to enable munchkin on the derived pages. Defaults to true

required
object (Folder)

JSON representation of a folder

name
required
string

Name of the landing page template

templateType
string

Type of template to create. Defaults to freeForm

Enum: "guided" "freeForm"
Responses
200

OK

post/rest/asset/v1/landingPageTemplates.json
Request samples
application/x-www-form-urlencoded
description=string&enableMunchkin=true&id=0&type=Folder&name=string&templateType=guided
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Programs

Program Controller

Get Program by Name

Retrieves the program record for the given name. Required Permissions: Read-Only Assets, Read-Write Assets

Request
query Parameters
name
required
string

Name of the program

includeTags
boolean

Set true to populate program tags

includeCosts
boolean

Set true to populate program costs

Responses
200

OK

get/rest/asset/v1/program/byName.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Programs by Tag

Retrieves a list of programs matching the tag type and tag values given. Required Permissions: Read-Only Assets, Read-Write Assets

Request
query Parameters
tagType
required
string

Type of program tag

tagValue
required
string

Value of the tag

maxReturn
integer <int32>

Maximum number of channels to return. Max 200, default 20

offset
integer <int32>

Integer offset for paging

Responses
200

OK

get/rest/asset/v1/program/byTag.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Program by Id

Retrieves the program record for the given id. Required Permissions: Read-Only Assets, Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Responses
200

OK

get/rest/asset/v1/program/{id}.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Update Program Metadata

Updates the target program's metadata. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Request Body schema: application/x-www-form-urlencoded
required

updateProgramRequest

Array of objects (CostRequest)

Lists of associated period costs that allow you to append, replace, or delete. To append new costs, simply add them to costs array. To replace costs (destructive update), pass new costs and set costsDestructiveUpdate to true. To delete costs, do not pass costs parameter and set costsDestructiveUpdate to true

costsDestructiveUpdate
boolean

Set true to destroy existing costs and replace them with the specified costs

description
string

Updated description for the program

endDate
string

End date of the program. Applicable to event, email, and webinar type programs

name
string

Name of the program

startDate
string

Start date of program. Applicable to event, email and webinar type programs

Array of objects (TagRequest)

List of associated program tags

Responses
200

OK

post/rest/asset/v1/program/{id}.json
Request samples
application/x-www-form-urlencoded
costs=%5Bobject%20Object%5D&costsDestructiveUpdate=true&description=string&endDate=string&name=string&startDate=string&tags=%5Bobject%20Object%5D
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Smart List by Program Id

Retrieves a Smart List record by its Email Program id. Required Permissions: Read-Asset or Read-Write Asset

Request
path Parameters
programId
required
integer <int64>

Id for the email program containing smart list to retrieve

query Parameters
includeRules
boolean

Set true to populate smart list rules. Default false

Responses
200

OK

get/rest/asset/v1/program/{programId}/smartList.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Approve Program

Approves the target program. Only valid for unapproved email programs. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Responses
200

OK

post/rest/asset/v1/program/{id}/approve.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Clone Program

Clones the target program. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Request Body schema: application/x-www-form-urlencoded
required

cloneProgramRequest

description
string
required
object (Folder)

JSON representation of a folder

name
required
string

Name of the program. Max 255 characters

Responses
200

OK

post/rest/asset/v1/program/{id}/clone.json
Request samples
application/x-www-form-urlencoded
description=string&id=0&type=Folder&name=string
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Delete Program

Deletes the target program. The program may not contain any assets which are in use outside the program. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Responses
200

OK

post/rest/asset/v1/program/{id}/delete.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Unapprove Program

Unapproves the target program. Only valid for approved email programs. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Responses
200

OK

post/rest/asset/v1/program/{id}/unapprove.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Programs

Retrieves the list of accessible programs from the target instance. Required Permissions: Read-Only Assets, Read-Write Assets

Request
query Parameters
maxReturn
integer <int32>

Maximum number of channels to return. Max 200, default 20

offset
integer <int32>

Integer offset for paging

filterType
string

Optional filter. Requires filterValues

Enum: "id" "programId" "folderId" "workspace"
earliestUpdatedAt
string

Exclude programs prior to this date. Must be valid ISO-8601 string. See Datetime field type description.

latestUpdatedAt
string

Exclude programs after this date. Must be valid ISO-8601 string. See Datetime field type description.

Responses
200

OK

get/rest/asset/v1/programs.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Create Program

Creates a new program. Required Permissions: Read-Write Assets

Request
Request Body schema: application/x-www-form-urlencoded
required

createProgramRequest

channel
required
string

Channel of the program

Array of objects (CostRequest)

Lists of associated period costs

description
string
required
object (Folder)

JSON representation of a folder

name
required
string

Name of the program

Array of objects (TagRequest)

List of associated program tags

type
required
string

Type of the program

Responses
200

OK

post/rest/asset/v1/programs.json
Request samples
application/x-www-form-urlencoded
channel=string&costs=%5Bobject%20Object%5D&description=string&id=0&type=Folder&name=string&tags=%5Bobject%20Object%5D&type=string
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Segments

Segment Controller

Get Segmentations

Retrieves a list of accessible segmentations for the target instance. Required Permissions: Read-Only Assets, Read-Write Assets

Request
query Parameters
status
string

Status filter for draft or approved versions

Enum: "approved" "draft"
Responses
200

OK

get/rest/asset/v1/segmentation.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Segments For Segmentation

Retrieves a list of segments inside the target segmentation. Required Permissions: Read-Only Assets, Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

query Parameters
status
string

Status filter for draft or approved versions

Enum: "approved" "draft"
offset
integer <int32>

Integer offset for paging

maxReturn
integer <int32>

Maximum number of channels to return. Max 200, default 20

Responses
200

OK

get/rest/asset/v1/segmentation/{id}/segments.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Smart Campaigns

Smart Campaign Controller

Get Smart Campaign by Id

Returns the smart campaign for the given id. Required Permissions: Read-Only Assets, Read-Write Assets

Request
path Parameters
id
required
integer <int32>

Id for the smart campaign

Responses
200

OK

get/rest/asset/v1/smartCampaign/{id}.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Update Smart Campaign

Update the smart campaign for the given id. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

Id for the smart campaign

Request Body schema: application/json
required

updateSmartCampaignRequest

description
string

Description of the smart campaign

name
string

Name of the smart campaign

Responses
200

OK

post/rest/asset/v1/smartCampaign/{id}.json
Request samples
application/json
{
  • "description": "string",
  • "name": "string"
}
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Smart Campaign by Name

Returns the smart campaign for the given name. Required Permissions: Read-Only Assets, Read-Write Assets

Request
query Parameters
name
required
string

Name for the smart campaign

Responses
200

OK

get/rest/asset/v1/smartCampaign/byName.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Smart List by Smart Campaign Id

Retrieves a Smart List record by its Smart Campaign id. Required Permissions: Read-Asset or Read-Write Asset

Request
path Parameters
id
required
integer <int64>

Id for the smart campaign containing smart list to retrieve

query Parameters
includeRules
boolean

Set true to populate smart list rules. Default false

Responses
200

OK

get/rest/asset/v1/smartCampaign/{id}/smartList.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Smart Campaigns

Retrieves all smart campaigns. Required Permissions: Read-Only Assets, Read-Write Assets

Request
query Parameters
maxReturn
integer <int32>

Maximum number of smart campaigns to return. Max 200, default 20

offset
integer <int32>

Integer offset for paging

folder
string

JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'

earliestUpdatedAt
string

Exclude smart campaigns prior to this date. Must be valid ISO-8601 string. See Datetime field type description.

latestUpdatedAt
string

Exclude smart campaigns after this date. Must be valid ISO-8601 string. See Datetime field type description.

isActive
boolean

Set true to return only active campaigns. Default false

Responses
200

OK

get/rest/asset/v1/smartCampaigns.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Create Smart Campaign

Creates a new smart campaign. Required Permissions: Read-Write Assets

Request
Request Body schema: application/x-www-form-urlencoded
required

createSmartCampaignRequest

description
string

Description of the smart campaign

required
object (Folder)

JSON representation of a folder

name
required
string

Name of the smart campaign

Responses
200

OK

post/rest/asset/v1/smartCampaigns.json
Request samples
application/x-www-form-urlencoded
description=string&id=0&type=Folder&name=string
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Activate Smart Campaign

Activates a trigger smart campaign. Required Permissions: Activate Campaign

Request
path Parameters
id
required
integer <int32>

Id of the smart campaign

Responses
200

OK

post/rest/asset/v1/smartCampaign/{id}/activate.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Deactivate Smart Campaign

Deactivates a trigger smart campaign. Required Permissions: Deactivate Campaign

Request
path Parameters
id
required
integer <int32>

Id of the smart campaign

Responses
200

OK

post/rest/asset/v1/smartCampaign/{id}/deactivate.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Clone Smart Campaign

Clones a smart campaign. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

Id of the smart campaign

Request Body schema: application/x-www-form-urlencoded
required

cloneSmartCampaignRequest

description
string

Description of the smart campaign

required
object (Folder)

JSON representation of a folder

name
required
string

Name of the smart campaign

Responses
200

OK

post/rest/asset/v1/smartCampaign/{id}/clone.json
Request samples
application/x-www-form-urlencoded
description=string&id=0&type=Folder&name=string
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Delete Smart Campaign

Deletes a smart campaign. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

Id of the smart campaign

Responses
200

OK

post/rest/asset/v1/smartCampaign/{id}/delete.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Smart Lists

Smart List Controller

Get Smart List by Id

Retrieves a Smart List record by its id. Required Permissions: Read-Asset or Read-Write Asset

Request
path Parameters
id
required
integer <int64>

Id of the smart list to retrieve

query Parameters
includeRules
boolean

Set true to populate smart list rules. Default false

Responses
200

OK

get/rest/asset/v1/smartList/{id}.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Smart List by Name

Retrieves a Smart List record by its name. Required Permissions: Read-Asset or Read-Write Asset

Request
query Parameters
name
required
string

Name of smart list to retrieve

Responses
200

OK

get/rest/asset/v1/smartList/byName.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Delete Smart List

Deletes the designated Smart List. Required Permissions: Read-Write Asset

Request
path Parameters
id
required
integer <int64>

Id of the smart list to delete

Responses
200

OK

post/rest/asset/v1/smartList/{id}/delete.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Smart Lists

Retrieves a list of user created Smart List records. Required Permissions: Read-Asset or Read-Write Asset

Request
query Parameters
folder
string

JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'

offset
integer <int32>

Integer offset for paging

maxReturn
integer <int32>

Maximum number of smart lists to return. Max 200, default 20.

earliestUpdatedAt
string

Exclude smart lists prior to this date. Must be valid ISO-8601 string. See Datetime field type description.

latestUpdatedAt
string

Exclude smart lists after this date. Must be valid ISO-8601 string. See Datetime field type description.

Responses
200

OK

get/rest/asset/v1/smartLists.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Clone Smart List

Clones the designated Smart List. Required Permissions: Read-Write Asset

Request
path Parameters
id
required
integer <int32>

Id of smart list to clone

Request Body schema: application/x-www-form-urlencoded
required

cloneSmartListRequest

name
required
string

Name for the cloned smart list

required
object (Folder)

JSON representation of a folder

description
string

Description of the cloned smart list

Responses
200

OK

post/rest/asset/v1/smartList/{id}/clone.json
Request samples
application/x-www-form-urlencoded
name=string&id=0&type=Folder&description=string
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Snippets

Snippet Controller

Get Snippet by Id

Retrieves the target snippet record. Required Permissions: Read-Only Assets, Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

query Parameters
status
string

Status filter for draft or approved versions

Enum: "approved" "draft"
Responses
200

OK

get/rest/asset/v1/snippet/{id}.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Update Snippet Metadata

Updates the metadata of the snippet. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Request Body schema: application/x-www-form-urlencoded
required

updateSnippetRequest

description
string

Description of the snippet

isArchive
string

Archival status of the snippet

name
string

Name of the snippet

Responses
200

OK

post/rest/asset/v1/snippet/{id}.json
Request samples
application/x-www-form-urlencoded
description=string&isArchive=string&name=string
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Approve Snippet Draft

Approves the current draft of the snippet. Required Permissions: Approve Assets

Request
path Parameters
id
required
integer <int32>

id

Responses
200

OK

post/rest/asset/v1/snippet/{id}/approveDraft.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Clone Snippet

Clones the target snippet. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Request Body schema: application/x-www-form-urlencoded

cloneSnippetRequest

name
required
string

Name for the cloned snippet

required
object (Folder)

JSON representation of a folder

description
string

Description of the cloned snippet

Responses
200

OK

post/rest/asset/v1/snippet/{id}/clone.json
Request samples
application/x-www-form-urlencoded
name=string&id=0&type=Folder&description=string
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Snippet Content

Retrieves the content of the target snippet. Required Permissions: Read-Only Assets, Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

query Parameters
status
string

Status filter for draft or approved versions

Enum: "approved" "draft"
Responses
200

OK

get/rest/asset/v1/snippet/{id}/content.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Update Snippet Content

Updates the content of the target snippet. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

query Parameters
content
required
string

Content of the snippet

type
required
string

Type of snippet content

Enum: "DynamicContent" "HTML" "Text"
Responses
200

OK

post/rest/asset/v1/snippet/{id}/content.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Delete Snippet

Deletes the target snippet. The snippet may not be in use by emails or landing pages. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Responses
200

OK

post/rest/asset/v1/snippet/{id}/delete.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Discard Snippet Draft

Discards the current draft of the snippet. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Responses
200

OK

post/rest/asset/v1/snippet/{id}/discardDraft.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Dynamic Content

Gets the list of dynamic content sections for the snippet. Required Permissions: Read-Only Assets, Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

query Parameters
status
string

Status filter for draft or approved versions

Enum: "approved" "draft"
Responses
200

OK

get/rest/asset/v1/snippet/{id}/dynamicContent.json
Response samples
application/json
{ }

Update Snippet Dynamic Content

Updates the target dynamic content section. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

segmentId
required
integer <int32>

segmentId

Request Body schema: application/x-www-form-urlencoded
required

request

type
string

Type of dynamic content section

Value: "Typeofcontent.Either'HTML'or'Text'"
value
string

Value of the dynamic content section

Responses
200

OK

post/rest/asset/v1/snippet/{id}/dynamicContent/{segmentId}.json
Request samples
application/x-www-form-urlencoded
type=Typeofcontent.Either%27HTML%27or%27Text%27&value=string
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Unapprove Snippet

Unapproves the current version of the snippet. The snippet may not be in use. The snippet will be reverted to a draft-only state. Required Permissions: Approve Assets

Request
path Parameters
id
required
integer <int32>

id

Responses
200

OK

post/rest/asset/v1/snippet/{id}/unapprove.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Snippets

Retrieves a list of accessible snippets from the target instance. Required Permissions: Read-Only Assets, Read-Write Assets

Request
query Parameters
status
string

Status filter for draft or approved versions

Enum: "approved" "draft"
maxReturn
integer <int32>

Maximum number of channels to return. Max 200, default 20

offset
integer <int32>

Integer offset for paging

Responses
200

OK

get/rest/asset/v1/snippets.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Create Snippet

Creates a new snippet. Required Permissions: Read-Write Assets

Request
Request Body schema: application/x-www-form-urlencoded
required

createSnippetRequest

description
string

Description of the snippet

required
object (Folder)

JSON representation of a folder

name
required
string

Name of the snippet

Responses
200

OK

post/rest/asset/v1/snippets.json
Request samples
application/x-www-form-urlencoded
description=string&id=0&type=Folder&name=string
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Static Lists

Static List Controller

Get Static List by Id

Retrieves a Static List record by its id. Required Permissions: Read-Asset or Read-Write Asset

Request
path Parameters
id
required
integer <int64>

Id of the static list to retrieve

Responses
200

OK

get/rest/asset/v1/staticList/{id}.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Update Static List Metadata

Updates the metadata of a static list asset. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

Id of static list to update

Request Body schema: application/x-www-form-urlencoded
required

updateStaticListRequest

description
string

Description of the static list

name
string

Name of the static list

Responses
200

OK

post/rest/asset/v1/staticList/{id}.json
Request samples
application/x-www-form-urlencoded
description=string&name=string
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Static Lists

Retrieves a list of Static List records. Required Permissions: Read-Asset or Read-Write Asset

Request
query Parameters
folder
string

JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'

offset
integer <int32>

Integer offset for paging

maxReturn
integer <int32>

Maximum number of static lists to return. Max 200, default 20.

earliestUpdatedAt
string

Exclude static lists prior to this date. Must be valid ISO-8601 string. See Datetime field type description.

latestUpdatedAt
string

Exclude static lists after this date. Must be valid ISO-8601 string. See Datetime field type description.

Responses
200

OK

get/rest/asset/v1/staticLists.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Create Static List

Creates a new Static List. Required Permissions: Read-Write Assets

Request
Request Body schema: application/x-www-form-urlencoded
required

createStaticListRequest

description
string

Description of the static list

name
required
string

Name of the static list

required
object (Folder)

JSON representation of a folder

Responses
200

OK

post/rest/asset/v1/staticLists.json
Request samples
application/x-www-form-urlencoded
description=string&name=string&id=0&type=Folder
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Static List by Name

Retrieves a Static List record by its name. Required Permissions: Read-Asset or Read-Write Asset

Request
query Parameters
name
required
string

Name of static list to retrieve

Responses
200

OK

get/rest/asset/v1/staticList/byName.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Delete Static List

Deletes the designated Static List. Required Permissions: Read-Write Asset

Request
path Parameters
id
required
integer <int64>

Id of the static list to delete

Responses
200

OK

post/rest/asset/v1/staticList/{id}/delete.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Tags

Tag Controller

Get Tag By Name

Retrieves a tag by its name. This will also return the set of valid values for the tag. Required Permissions: Read-Only Assets, Read-Write Assets

Request
query Parameters
name
required
string

Name of the tag

Responses
200

OK

get/rest/asset/v1/tagType/byName.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Get Tag Types

Retrieves a list of available tag types. Required Permissions: Read-Only Assets, Read-Write Assets

Request
query Parameters
maxReturn
integer <int32>

Maximum number of channels to return. Max 200, default 20

offset
integer <int32>

Integer offset for paging

Responses
200

OK

get/rest/asset/v1/tagTypes.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Tokens

Token Controller

Get Tokens by Folder Id

Retrieves the list of available My Tokens in the target folder. Required Permissions: Read-Only Assets, Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

query Parameters
folderType
string
Default: "Folder"

Type of folder. 'Folder' or 'Program'

Enum: "Folder" "Program"
Responses
200

OK

get/rest/asset/v1/folder/{id}/tokens.json
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Create Token

Create or update a token in the parent folder. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

Id of the folder to which the token will be associated with

Request Body schema: application/x-www-form-urlencoded
required

createTokenRequest

folderType
required
string

Type of folder. 'Folder' or 'Program'

Enum: "Program" "Folder"
name
required
string

Name of the token. Max length is 50 characters)

type
required
string

Type of the token

Enum: "date" "number" "rich text" "score" "sfdc campaign" "text"
value
required
string

Value of the token

Responses
200

OK

post/rest/asset/v1/folder/{id}/tokens.json
Request samples
application/x-www-form-urlencoded
folderType=Program&name=string&type=date&value=string
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}

Delete Token by Name

Deletes a token with the given name from the parent folder. Required Permissions: Read-Write Assets

Request
path Parameters
id
required
integer <int32>

id

Request Body schema: application/x-www-form-urlencoded
required

deleteTokenRequest

folderType
string
Enum: "Program" "Folder"
name
string
type
string
Responses
200

OK

post/rest/asset/v1/folder/{id}/tokens/delete.json
Request samples
application/x-www-form-urlencoded
folderType=Program&name=string&type=string
Response samples
application/json
{
  • "errors": [
    ],
  • "requestId": "string",
  • "result": [
    ],
  • "success": true,
  • "warnings": [
    ]
}