Version 1
Connector Overview: This page documents all 166 actions for the Marketoassetconnector v1.
Channels (2)
GET Get Channel by Name
/rest/asset/v1/channel/byName.json
Retrieves channels based on the provided name. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Channels
/rest/asset/v1/channels.json
Retrieves all channels. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Email Templates (13)
POST Approve Email Template Draft
/rest/asset/v1/emailTemplate/{id}/approveDraft.json
Approves the current draft of the email template. Required Permissions: Approve Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Clone Email Template
/rest/asset/v1/emailTemplate/{id}/clone.json
Clones the designated email template. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create Email Template
/rest/asset/v1/emailTemplates.json
Creates a new email template. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Delete Email Template
/rest/asset/v1/emailTemplate/{id}/delete.json
Deletes the designated email template. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Discard Email Template Draft
/rest/asset/v1/emailTemplate/{id}/discardDraft.json
Discards the current draft of the email template. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Email Template Content by Id
/rest/asset/v1/emailTemplate/{id}/content
Returns the content for a given email template. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Email Template Used By
/rest/asset/v1/emailTemplates/{id}/usedBy.json
Returns a list of email records which depend on a given email template. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Email Template by Id
/rest/asset/v1/emailTemplate/{id}.json
Returns an email template record by its id. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Email Template by Name
/rest/asset/v1/emailTemplate/byName.json
Retrieves and email template record by the given name. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Email Templates
/rest/asset/v1/emailTemplates.json
Returns a list of email template records accessible in the target instance. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Unapprove Email Template Draft
/rest/asset/v1/emailTemplate/{id}/unapprove.json
Unapproves the current approved version of the Email Template. Required Permissions: Approve Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update Email Template Content
/rest/asset/v1/emailTemplate/{id}/content.json
Updates the content of the given email template. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update Email Template Metadata
/rest/asset/v1/emailTemplate/{id}.json
Updates the metadata for the designated email template. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Emails (26)
POST Add Email Module
/rest/asset/v1/email/{id}/content/{moduleId}/add.json
Adds a new module to an email, with the given id. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Approve Email Draft
/rest/asset/v1/email/{id}/approveDraft.json
Approves the current draft of an email. Required Permissions: Approve Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Clone Email
/rest/asset/v1/email/{id}/clone.json
Clones the target email. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create Email
/rest/asset/v1/emails.json
Creates a new email asset. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Delete Email
/rest/asset/v1/email/{id}/delete.json
Deletes the target email. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Delete Module
/rest/asset/v1/email/{id}/content/{moduleId}/delete.json
Deletes the given module from the email. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Discard Email Draft
/rest/asset/v1/email/{id}/discardDraft.json
Discards the current draft of an email. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Duplicate Email Module
/rest/asset/v1/email/{id}/content/{moduleId}/duplicate.json
Creates a copy of the designated module in an email. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Email By Id
/rest/asset/v1/email/{id}.json
Returns an email records by its id. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Email CC Fields
/rest/asset/v1/email/ccFields.json
Returns the set of fields enabled for Email CC in the target instance. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Email Content
/rest/asset/v1/email/{id}/content.json
Returns the content of the designated email. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Email Dynamic Content
/rest/asset/v1/email/{id}/dynamicContent/{contentId}.json
Retrieves the dyanmic content record for the given section. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Email Full Content
/rest/asset/v1/email/{id}/fullContent.json
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.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Email Variables
/rest/asset/v1/email/{id}/variables.json
Returns a list of the available variables in an email. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Email by Name
/rest/asset/v1/email/byName.json
Returns an email records based on the given name. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Emails
/rest/asset/v1/emails.json
Returns a list of emails matching the given filter parameters. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Rearrange Email Modules
/rest/asset/v1/email/{id}/content/rearrange.json
Rearranges the modules in an email. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Rename Email Module
/rest/asset/v1/email/{id}/content/{moduleId}/rename.json
Renames a module. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Send Sample Email
/rest/asset/v1/email/{id}/sendSample.json
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
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Unapprove Email
/rest/asset/v1/email/{id}/unapprove.json
Unapproves the email and reverts it to a draft-only state. Required Permissions: Approve Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update Email Content
/rest/asset/v1/email/{id}/content.json
Updates the content of an email. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update Email Content Section
/rest/asset/v1/email/{id}/content/{htmlId}.json
Updates the content in the given section. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update Email Dynamic Content Section
/rest/asset/v1/email/{id}/dynamicContent/{contentId}.json
Updates dynamic content in the given section. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update Email Full Content
/rest/asset/v1/email/{id}/fullContent.json
Replaces the HTML of an Email that has had its relationship broken from its template. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update Email Metadata
/rest/asset/v1/email/{id}.json
Updates the metadata of an email asset. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update Email Variable
/rest/asset/v1/email/{id}/variable/{name}.json
Updates the value of a given variable in an email. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
File Contents
POST Update File Content
/rest/asset/v1/file/{id}/content.json
Replaces the current content of the file with the included payload. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Files (4)
POST Create File
/rest/asset/v1/files.json
Creates a new file from the included payload. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get File by Id
/rest/asset/v1/file/{id}.json
Returns the file record for the given id. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get File by Name
/rest/asset/v1/file/byName.json
Returns files records for the given name. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Files
/rest/asset/v1/files.json
Returns the files from the given folder. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Folders (7)
POST Create Folder
/rest/asset/v1/folders.json
Creates a new folder. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Delete Folder
/rest/asset/v1/folder/{id}/delete.json
Deletes the designated folder. Deletion will fail if the folder has content. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Folder Contents
/rest/asset/v1/folder/{id}/content.json
Returns records for the contents of a given folder. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Folder by Id
/rest/asset/v1/folder/{id}.json
Returns the folder record with the given id. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Folder by Name
/rest/asset/v1/folder/byName.json
Returns a folder record for the given name. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Folders
/rest/asset/v1/folders.json
Retrieves child folders from within a given root folder. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update Folder Metadata
/rest/asset/v1/folder/{id}.json
Updates the metadata for a given folder. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Form Fields (11)
POST Add Field to Form
/rest/asset/v1/form/{id}/fields.json
Adds a field to a form. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Add Fieldset to Form
/rest/asset/v1/form/{id}/fieldSet.json
Adds a field set to the target form. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Add Form Field Visibility Rules
/rest/asset/v1/form/{formId}/field/{fieldId}/visibility.json
Adds a visibility rule to the target form field. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Add Rich Text Field
/rest/asset/v1/form/{id}/richText.json
Adds a rich-text type field to the form. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Delete Field from Fieldset
/rest/asset/v1/form/{id}/fieldSet/{fieldSetId}/field/{fieldId}/delete.json
Removes the target field from the fieldset. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Delete Form Field
/rest/asset/v1/form/{id}/field/{fieldId}/delete.json
Deletes a field from a form. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Available Form Fields
/rest/asset/v1/form/fields.json
Retrieves a list of all valid fields for use in forms. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Available Form Program Member Fields
/rest/asset/v1/form/programMemberFields.json
Retrieves a list of all valid Program Member fields for use in forms. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Fields for Form
/rest/asset/v1/form/{id}/fields.json
Retrieves the list of fields in the target form. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update Field Positions
/rest/asset/v1/form/{id}/reArrange.json
Reorders the list of fields in a form. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update Form Field
/rest/asset/v1/form/{id}/field/{fieldId}.json
Updates the configuration for that target field. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Forms (13)
POST Approve Form Draft
/rest/asset/v1/form/{id}/approveDraft.json
Approves the current draft of the form. This will delete the current approved version of the form. Required Permissions: Approve Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Clone Form
/rest/asset/v1/form/{id}/clone.json
Clones the target form. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create Form
/rest/asset/v1/forms.json
Creates a new form. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Delete Form
/rest/asset/v1/form/{id}/delete.json
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
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Discard Form Draft
/rest/asset/v1/form/{id}/discardDraft.json
Discards the current draft of the form. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Form By Id
/rest/asset/v1/form/{id}.json
Retrieves a form record by its id. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Form Used By
/rest/asset/v1/form/{id}/usedBy.json
Returns a list of asset records which depend on a given form. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Form by Name
/rest/asset/v1/form/byName.json
Retrieves a form record by its name. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Forms
/rest/asset/v1/forms.json
Retrieves a list of accessible form records from the target instance. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Thank You Page by Form Id
/rest/asset/v1/form/{id}/thankYouPage.json
Returns the thank you page configuration for a given form. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update Form Metadata
/rest/asset/v1/form/{id}.json
Updates the metadata of the target form. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update Submit Button
/rest/asset/v1/form/{id}/submitButton.json
Updates the submit button configuration for the target form. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update Thank You Page
/rest/asset/v1/form/{id}/thankYouPage.json
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
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Landing Page Content (6)
POST Add Landing Page Content Section
/rest/asset/v1/landingPage/{id}/content.json
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
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Delete Landing Page Content Section
/rest/asset/v1/landingPage/{id}/content/{contentId}/delete.json
Removes the target content section from the parent landing page. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Landing Page Content
/rest/asset/v1/landingPage/{id}/content.json
Retrieves the list of content sections in the target landing page. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Landing Page Dynamic Content
/rest/asset/v1/landingPage/{id}/dynamicContent/{contentId}.json
Retrieves the dynamic content from the target section. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update Landing Page Content Section
/rest/asset/v1/landingPage/{id}/content/{contentId}.json
Updates a content section the landing page. Parameters must be sent as application/x-www-form-urlencoded (not JSON). Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update Landing Page Dynamic Content Section
/rest/asset/v1/landingPage/{id}/dynamicContent/{contentId}.json
Updates the content of the target dynamic content section. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Landing Page Redirect Rules (6)
POST Create Landing Page Redirect Rule
/rest/asset/v1/redirectRules.json
Create a new landing page redirect rule. Required Permissions: Read Write Redirect Rules
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Delete Landing Page Redirect Rule
/rest/asset/v1/redirectRule/{id}/delete.json
Delete a landing page redirect rule. Required Permissions: Read Write Redirect Rules
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Landing Page Domains
/rest/asset/v1/landingPageDomains.json
Retrieves a list of landing page domain and domain aliases. Required Permissions: Read Only Redirect Rules, Read Write Redirect Rules
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Landing Page Redirect Rule by Id
/rest/asset/v1/redirectRule/{id}.json
Retrieves the landing page redirect rule record. Required Permissions: Read Only Redirect Rules, Read Write Redirect Rules
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Landing Page Redirect Rules
/rest/asset/v1/redirectRules.json
Retrieves a list of landing page redirect rules from the target instance. Required Permissions: Read Only Redirect Rules, Read Write Redirect Rules
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update Landing Page Redirect Rule
/rest/asset/v1/redirectRule/{id}.json
Update an existing landing page redirect rule. Required Permissions: Read Write Redirect Rules
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Landing Page Templates (12)
POST Approve Landing Page Template Draft
/rest/asset/v1/landingPageTemplate/{id}/approveDraft.json
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
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Clone Landing Page Template
/rest/asset/v1/landingPageTemplate/{id}/clone.json
Clones the target landing page template. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create Landing Page Template
/rest/asset/v1/landingPageTemplates.json
Creates a new landing page template. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Delete Landing Page Template
/rest/asset/v1/landingPageTemplate/{id}/delete.json
Deletes the target landing page template. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Discard Landing Page Template Draft
/rest/asset/v1/landingPageTemplate/{id}/discardDraft.json
Discrads the current draft of the landing page template. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Landing Page Template Content
/rest/asset/v1/landingPageTemplate/{id}/content.json
Retrieves the content of the target landing page. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Landing Page Template by Id
/rest/asset/v1/landingPageTemplate/{id}.json
Retrieves the record for the target landing page template. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Landing Page Template by Name
/rest/asset/v1/landingPageTemplate/byName.json
Retrieves the landing page template record for the given name. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Landing Page Templates
/rest/asset/v1/landingPageTemplates.json
Retrieves the list of accessible landing page templates from the target instance. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Unapprove Landing Page Template
/rest/asset/v1/landingPageTemplate/{id}/unapprove.json
Unapproves the landing page template and reverts it to a draft-only state. Required Permissions: Approve Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update Landing Page Template Content
/rest/asset/v1/landingPageTemplate/{id}/content.json
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
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update Landing Page Template Metadata
/rest/asset/v1/landingPageTemplate/{id}.json
Updates the metadata for the target landing page template. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Landing Pages (13)
POST Approve Landing Page Draft
/rest/asset/v1/landingPage/{id}/approveDraft.json
Approves the current draft of the landing page. Required Permissions: Approve Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Clone Landing Page
/rest/asset/v1/landingPage/{id}/clone.json
Clones the target landing page. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create Landing Page
/rest/asset/v1/landingPages.json
Creates a new landing page. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Delete Landing Page
/rest/asset/v1/landingPage/{id}/delete.json
Deletes the target landing page. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Discard Landing Page Draft
/rest/asset/v1/landingPage/{id}/discardDraft.json
Discards the current draft of the landing page. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Landing Page Full Content
/rest/asset/v1/landingPage/{id}/fullContent.json
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.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Landing Page Variables
/rest/asset/v1/landingPage/{id}/variables.json
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Landing Page by Id
/rest/asset/v1/landingPage/{id}.json
Returns the landing record for the given id. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Landing Page by Name
/rest/asset/v1/landingPage/byName.json
Returns the landing page record for the given name. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Landing Pages
/rest/asset/v1/landingPages.json
Retrieves a list of accessible landing pages from the target instance. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Unapprove Landing Page
/rest/asset/v1/landingPage/{id}/unapprove.json
Unapproves the landing page, reverting it to a draft-only state. Required Permissions: Approve Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update Landing Page Metadata
/rest/asset/v1/landingPage/{id}.json
Updates the metadata for the targe landing page. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update Landing Page Variable
/rest/asset/v1/landingPage/{id}/variable/{variableId}.json
Updates the value of the given variable. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Programs (11)
POST Approve Program
/rest/asset/v1/program/{id}/approve.json
Approves the target program. Only valid for unapproved email programs. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Clone Program
/rest/asset/v1/program/{id}/clone.json
Clones the target program. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create Program
/rest/asset/v1/programs.json
Creates a new program. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Delete Program
/rest/asset/v1/program/{id}/delete.json
Deletes the target program. The program may not contain any assets which are in use outside the program. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Program by Id
/rest/asset/v1/program/{id}.json
Retrieves the program record for the given id. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Program by Name
/rest/asset/v1/program/byName.json
Retrieves the program record for the given name. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Programs
/rest/asset/v1/programs.json
Retrieves the list of accessible programs from the target instance. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Programs by Tag
/rest/asset/v1/program/byTag.json
Retrieves a list of programs matching the tag type and tag values given. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Smart List by Program Id
/rest/asset/v1/program/{programId}/smartList.json
Retrieves a Smart List record by its Email Program id. Required Permissions: Read-Asset or Read-Write Asset
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Unapprove Program
/rest/asset/v1/program/{id}/unapprove.json
Unapproves the target program. Only valid for approved email programs. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update Program Metadata
/rest/asset/v1/program/{id}.json
Updates the target program's metadata. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Segments (2)
GET Get Segmentations
/rest/asset/v1/segmentation.json
Retrieves a list of accessible segmentations for the target instance. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Segments For Segmentation
/rest/asset/v1/segmentation/{id}/segments.json
Retrieves a list of segments inside the target segmentation. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Smart Campaigns (10)
POST Activate Smart Campaign
/rest/asset/v1/smartCampaign/{id}/activate.json
Activates a trigger smart campaign. Required Permissions: Activate Campaign
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Clone Smart Campaign
/rest/asset/v1/smartCampaign/{id}/clone.json
Clones a smart campaign. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create Smart Campaign
/rest/asset/v1/smartCampaigns.json
Creates a new smart campaign. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Deactivate Smart Campaign
/rest/asset/v1/smartCampaign/{id}/deactivate.json
Deactivates a trigger smart campaign. Required Permissions: Deactivate Campaign
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Delete Smart Campaign
/rest/asset/v1/smartCampaign/{id}/delete.json
Deletes a smart campaign. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Smart Campaign by Id
/rest/asset/v1/smartCampaign/{id}.json
Returns the smart campaign for the given id. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Smart Campaign by Name
/rest/asset/v1/smartCampaign/byName.json
Returns the smart campaign for the given name. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Smart Campaigns
/rest/asset/v1/smartCampaigns.json
Retrieves all smart campaigns. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Smart List by Smart Campaign Id
/rest/asset/v1/smartCampaign/{id}/smartList.json
Retrieves a Smart List record by its Smart Campaign id. Required Permissions: Read-Asset or Read-Write Asset
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update Smart Campaign
/rest/asset/v1/smartCampaign/{id}.json
Update the smart campaign for the given id. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Smart Lists (5)
POST Clone Smart List
/rest/asset/v1/smartList/{id}/clone.json
Clones the designated Smart List. Required Permissions: Read-Write Asset
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Delete Smart List
/rest/asset/v1/smartList/{id}/delete.json
Deletes the designated Smart List. Required Permissions: Read-Write Asset
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Smart List by Id
/rest/asset/v1/smartList/{id}.json
Retrieves a Smart List record by its id. Required Permissions: Read-Asset or Read-Write Asset
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Smart List by Name
/rest/asset/v1/smartList/byName.json
Retrieves a Smart List record by its name. Required Permissions: Read-Asset or Read-Write Asset
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Smart Lists
/rest/asset/v1/smartLists.json
Retrieves a list of user created Smart List records. Required Permissions: Read-Asset or Read-Write Asset
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Snippets (13)
POST Approve Snippet Draft
/rest/asset/v1/snippet/{id}/approveDraft.json
Approves the current draft of the snippet. Required Permissions: Approve Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Clone Snippet
/rest/asset/v1/snippet/{id}/clone.json
Clones the target snippet. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create Snippet
/rest/asset/v1/snippets.json
Creates a new snippet. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Delete Snippet
/rest/asset/v1/snippet/{id}/delete.json
Deletes the target snippet. The snippet may not be in use by emails or landing pages. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Discard Snippet Draft
/rest/asset/v1/snippet/{id}/discardDraft.json
Discards the current draft of the snippet. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Dynamic Content
/rest/asset/v1/snippet/{id}/dynamicContent.json
Gets the list of dynamic content sections for the snippet. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Snippet Content
/rest/asset/v1/snippet/{id}/content.json
Retrieves the content of the target snippet. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Snippet by Id
/rest/asset/v1/snippet/{id}.json
Retrieves the target snippet record. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Snippets
/rest/asset/v1/snippets.json
Retrieves a list of accessible snippets from the target instance. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Unapprove Snippet
/rest/asset/v1/snippet/{id}/unapprove.json
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
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update Snippet Content
/rest/asset/v1/snippet/{id}/content.json
Updates the content of the target snippet. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update Snippet Dynamic Content
/rest/asset/v1/snippet/{id}/dynamicContent/{segmentId}.json
Updates the target dynamic content section. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update Snippet Metadata
/rest/asset/v1/snippet/{id}.json
Updates the metadata of the snippet. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Static Lists (6)
POST Create Static List
/rest/asset/v1/staticLists.json
Creates a new Static List. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Delete Static List
/rest/asset/v1/staticList/{id}/delete.json
Deletes the designated Static List. Required Permissions: Read-Write Asset
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Static List by Id
/rest/asset/v1/staticList/{id}.json
Retrieves a Static List record by its id. Required Permissions: Read-Asset or Read-Write Asset
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Static List by Name
/rest/asset/v1/staticList/byName.json
Retrieves a Static List record by its name. Required Permissions: Read-Asset or Read-Write Asset
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Static Lists
/rest/asset/v1/staticLists.json
Retrieves a list of Static List records. Required Permissions: Read-Asset or Read-Write Asset
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update Static List Metadata
/rest/asset/v1/staticList/{id}.json
Updates the metadata of a static list asset. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Tags (2)
GET Get Tag By Name
/rest/asset/v1/tagType/byName.json
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
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Tag Types
/rest/asset/v1/tagTypes.json
Retrieves a list of available tag types. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Tokens (3)
POST Create Token
/rest/asset/v1/folder/{id}/tokens.json
Create or update a token in the parent folder. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Delete Token by Name
/rest/asset/v1/folder/{id}/tokens/delete.json
Deletes a token with the given name from the parent folder. Required Permissions: Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Tokens by Folder Id
/rest/asset/v1/folder/{id}/tokens.json
Retrieves the list of available My Tokens in the target folder. Required Permissions: Read-Only Assets, Read-Write Assets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |