openapi: 3.0.1
info:
title: Marketo Engage Rest Approve Assets API
description: Marketo exposes a REST API which allows for remote execution of many of the systems capabilities. From creating programs to bulk lead import, there are many options which allow fine-grained control of a Marketo instance.
termsOfService: https://www.adobe.com/legal.html
contact:
name: Adobe Developer Relations
url: https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/home
email: developerfeedback@marketo.com
license:
name: API License Agreement
url: https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/api-license
version: '1.0'
servers:
- url: https://localhost:8080/
tags:
- name: Assets
paths:
/rest/asset/v1/channel/byName.json:
get:
tags:
- Assets
summary: Marketo Get Channel by Name
description: 'Retrieves channels based on the provided name. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getChannelByNameUsingGET
parameters:
- name: Name
in: query
description: Name of channel to retrieve
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfChannelResponse'
/rest/asset/v1/channels.json:
get:
tags:
- Assets
summary: Marketo Get Channels
description: 'Retrieves all channels. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getAllChannelsUsingGET
parameters:
- name: maxReturn
in: query
description: Maximum number of channels to return. Max 200, default 20
schema:
type: integer
format: int32
- name: offset
in: query
description: Integer offset for paging
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfChannelResponse'
/rest/asset/v1/email/byName.json:
get:
tags:
- Assets
summary: Marketo Get Email by Name
description: 'Returns an email records based on the given name. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getEmailByNameUsingGET
parameters:
- name: name
in: query
description: Name of the email
required: true
schema:
type: string
- name: status
in: query
description: Status filter for draft or approved versions
schema:
type: string
enum:
- approved
- draft
- name: folder
in: query
description: JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfEmailResponse'
/rest/asset/v1/email/{id}.json:
get:
tags:
- Assets
summary: Marketo Get Email By Id
description: 'Returns an email records by its id. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getEmailByIdUsingGET
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
- name: status
in: query
description: Status filter for draft or approved versions
schema:
type: string
enum:
- approved
- draft
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfEmailResponse'
post:
tags:
- Assets
summary: Marketo Update Email Metadata
description: 'Updates the metadata of an email asset. Required Permissions: Read-Write Assets'
operationId: updateEmailUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
requestBody:
description: updateEmailRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/UpdateEmailMetaDataRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfEmailResponse'
x-codegen-request-body-name: updateEmailRequest
/rest/asset/v1/email/{id}/approveDraft.json:
post:
tags:
- Assets
summary: Marketo Approve Email Draft
description: 'Approves the current draft of an email. Required Permissions: Approve Assets'
operationId: approveDraftUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
/rest/asset/v1/email/{id}/clone.json:
post:
tags:
- Assets
summary: Marketo Clone Email
description: 'Clones the target email. Required Permissions: Read-Write Assets'
operationId: cloneEmailUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
requestBody:
description: cloneEmailRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CloneEmailRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfEmailResponse'
x-codegen-request-body-name: cloneEmailRequest
/rest/asset/v1/email/{id}/content.json:
get:
tags:
- Assets
summary: Marketo Get Email Content
description: 'Returns the content of the designated email. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getEmailContentByIdUsingGET
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
- name: status
in: query
description: Status filter for draft or approved versions
schema:
type: string
enum:
- approved
- draft
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfEmailContentResponse'
post:
tags:
- Assets
summary: Marketo Update Email Content
description: 'Updates the content of an email. Required Permissions: Read-Write Assets'
operationId: updateEmailContentUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
requestBody:
description: updateEmailRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/UpdateEmailComponentDataRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
x-codegen-request-body-name: updateEmailRequest
/rest/asset/v1/email/{id}/content/rearrange.json:
post:
tags:
- Assets
summary: Marketo Rearrange Email Modules
description: 'Rearranges the modules in an email. Required Permissions: Read-Write Assets'
operationId: rearrangeModulesUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
requestBody:
description: JSON array of module positions. Each position must be a JSON object with members 'index' and a 'moduleId'
content:
application/x-www-form-urlencoded:
schema:
type: string
required: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfEmailModuleResponse'
x-codegen-request-body-name: positions
/rest/asset/v1/email/{id}/content/{htmlId}.json:
post:
tags:
- Assets
summary: Marketo Update Email Content Section
description: 'Updates the content in the given section. Required Permissions: Read-Write Assets'
operationId: updateEmailComponentContentUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
- name: htmlId
in: path
description: htmlId
required: true
schema:
type: string
requestBody:
description: request
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/UpdateEmailComponentContentRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
x-codegen-request-body-name: request
/rest/asset/v1/email/{id}/content/{moduleId}/add.json:
post:
tags:
- Assets
summary: Marketo Add Email Module
description: 'Adds a new module to an email, with the given id. Required Permissions: Read-Write Assets'
operationId: addModuleUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
- name: moduleId
in: path
description: moduleId
required: true
schema:
type: string
- name: name
in: query
description: Name of the module
required: true
schema:
type: string
- name: index
in: query
description: Index of the module. Determines the order of the module in the email.
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfEmailModuleResponse'
/rest/asset/v1/email/{id}/content/{moduleId}/delete.json:
post:
tags:
- Assets
summary: Marketo Delete Module
description: 'Deletes the given module from the email. Required Permissions: Read-Write Assets'
operationId: deleteModuleUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
- name: moduleId
in: path
description: moduleId
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfEmailModuleResponse'
/rest/asset/v1/email/{id}/content/{moduleId}/duplicate.json:
post:
tags:
- Assets
summary: Marketo Duplicate Email Module
description: 'Creates a copy of the designated module in an email. Required Permissions: Read-Write Assets'
operationId: duplicateModuleUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
- name: moduleId
in: path
description: moduleId
required: true
schema:
type: string
- name: name
in: query
description: Name of the new module
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfEmailModuleResponse'
/rest/asset/v1/email/{id}/content/{moduleId}/rename.json:
post:
tags:
- Assets
summary: Marketo Rename Email Module
description: 'Renames a module. Required Permissions: Read-Write Assets'
operationId: renameUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
- name: moduleId
in: path
description: moduleId
required: true
schema:
type: string
- name: name
in: query
description: New module name
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfEmailModuleResponse'
/rest/asset/v1/email/{id}/delete.json:
post:
tags:
- Assets
summary: Marketo Delete Email
description: 'Deletes the target email. Required Permissions: Read-Write Assets'
operationId: deleteEmailUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
/rest/asset/v1/email/{id}/discardDraft.json:
post:
tags:
- Assets
summary: Marketo Discard Email Draft
description: 'Discards the current draft of an email. Required Permissions: Read-Write Assets'
operationId: discardDraftUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
/rest/asset/v1/email/{id}/dynamicContent/{contentId}.json:
get:
tags:
- Assets
summary: Marketo Get Email Dynamic Content
description: 'Retrieves the dyanmic content record for the given section. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getEmailDynamicContentUsingGET
parameters:
- name: id
in: path
description: Id of email
required: true
schema:
type: integer
format: int32
- name: contentId
in: path
description: Id of email dynamic content section
required: true
schema:
type: string
- name: status
in: query
description: Status filter for draft or approved versions
schema:
type: string
enum:
- approved
- draft
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfEmailDynamicContentResponse'
post:
tags:
- Assets
summary: Marketo Update Email Dynamic Content Section
description: 'Updates dynamic content in the given section. Required Permissions: Read-Write Assets'
operationId: updateEmailDynamicContentUsingPOST
parameters:
- name: id
in: path
description: Id of email
required: true
schema:
type: integer
format: int32
- name: contentId
in: path
description: Id of email dynamic content section
required: true
schema:
type: string
requestBody:
description: Content properties
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/UpdateEmailDynamicContentRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
x-codegen-request-body-name: request
/rest/asset/v1/email/{id}/sendSample.json:
post:
tags:
- Assets
summary: Marketo Send Sample Email
description: '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'
operationId: sendSampleEmailUsingPOST
parameters:
- name: id
in: path
description: Id of the email
required: true
schema:
type: integer
format: int32
requestBody:
description: sendSampleEmailRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SendSampleEmailRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfSendSampleResponse'
x-codegen-request-body-name: sendSampleEmailRequest
/rest/asset/v1/email/{id}/unapprove.json:
post:
tags:
- Assets
summary: Marketo Unapprove Email
description: 'Unapproves the email and reverts it to a draft-only state. Required Permissions: Approve Assets'
operationId: unapproveDraftUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
/rest/asset/v1/email/{id}/variable/{name}.json:
post:
tags:
- Assets
summary: Marketo Update Email Variable
description: 'Updates the value of a given variable in an email. Required Permissions: Read-Write Assets'
operationId: updateVariableUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
- name: name
in: path
description: name
required: true
schema:
type: string
requestBody:
description: updateVariableRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/UpdateVariableRequest'
required: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfEmailVariableResponse'
x-codegen-request-body-name: updateVariableRequest
/rest/asset/v1/email/{id}/variables.json:
get:
tags:
- Assets
summary: Marketo Get Email Variables
description: 'Returns a list of the available variables in an email. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getEmailVariablesUsingGET
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfEmailVariableResponse'
/rest/asset/v1/email/ccFields.json:
get:
tags:
- Assets
summary: Marketo Get Email CC Fields
description: 'Returns the set of fields enabled for Email CC in the target instance. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getEmailCCFieldsUsingGET
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfEmailCCFieldsResponse'
/rest/asset/v1/emailTemplate/byName.json:
get:
tags:
- Assets
summary: Marketo Get Email Template by Name
description: 'Retrieves and email template record by the given name. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getTemplateByNameUsingGET
parameters:
- name: name
in: query
description: name
required: true
schema:
type: string
- name: status
in: query
description: Status filter for draft or approved versions
schema:
type: string
enum:
- approved
- draft
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfEmailTemplateResponse'
/rest/asset/v1/emailTemplate/{id}.json:
get:
tags:
- Assets
summary: Marketo Get Email Template by Id
description: 'Returns an email template record by its id. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getTemplateByIdUsingGET
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
- name: status
in: query
description: Status filter for draft or approved versions
schema:
type: string
enum:
- approved
- draft
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfEmailTemplateResponse'
post:
tags:
- Assets
summary: Marketo Update Email Template Metadata
description: 'Updates the metadata for the designated email template. Required Permissions: Read-Write Assets'
operationId: updateEmailTemplateUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
requestBody:
description: updateEmailMetaDataRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/UpdateEmailTemplateMetaDataRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfEmailTemplateResponse'
x-codegen-request-body-name: updateEmailMetaDataRequest
/rest/asset/v1/emailTemplate/{id}/approveDraft.json:
post:
tags:
- Assets
summary: Marketo Approve Email Template Draft
description: 'Approves the current draft of the email template. Required Permissions: Approve Assets'
operationId: approveDraftUsingPOST_1
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfEmailTemplateResponse'
/rest/asset/v1/emailTemplate/{id}/clone.json:
post:
tags:
- Assets
summary: Marketo Clone Email Template
description: 'Clones the designated email template. Required Permissions: Read-Write Assets'
operationId: cloneTemplateUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
requestBody:
description: cloneEmailTemplateRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CloneEmailTemplateRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfEmailTemplateResponse'
x-codegen-request-body-name: cloneEmailTemplateRequest
/rest/asset/v1/emailTemplate/{id}/content:
get:
tags:
- Assets
summary: Marketo Get Email Template Content by Id
description: 'Returns the content for a given email template. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getTemplateContentByIdUsingGET
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
- name: status
in: query
description: Status filter for draft or approved versions
schema:
type: string
enum:
- approved
- draft
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfEmailTemplateContentResponse'
/rest/asset/v1/emailTemplate/{id}/content.json:
post:
tags:
- Assets
summary: Marketo Update Email Template Content
description: 'Updates the content of the given email template. Required Permissions: Read-Write Assets'
operationId: updateEmailTemplateContentUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
requestBody:
description: updateEmailTemplateContentRequest
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/UpdateEmailTemplateContentRequest'
required: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
x-codegen-request-body-name: updateEmailTemplateContentRequest
/rest/asset/v1/emailTemplate/{id}/delete.json:
post:
tags:
- Assets
summary: Marketo Delete Email Template
description: 'Deletes the designated email template. Required Permissions: Read-Write Assets'
operationId: deleteTemplateUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
/rest/asset/v1/emailTemplate/{id}/discardDraft.json:
post:
tags:
- Assets
summary: Marketo Discard Email Template Draft
description: 'Discards the current draft of the email template. Required Permissions: Read-Write Assets'
operationId: discardDraftUsingPOST_1
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
/rest/asset/v1/emailTemplate/{id}/unapprove.json:
post:
tags:
- Assets
summary: Marketo Unapprove Email Template Draft
description: 'Unapproves the current approved version of the Email Template. Required Permissions: Approve Assets'
operationId: unapproveDraftUsingPOST_1
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfEmailTemplateResponse'
/rest/asset/v1/emailTemplates.json:
get:
tags:
- Assets
summary: Marketo Get Email Templates
description: 'Returns a list of email template records accessible in the target instance. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getEmailTemplatesUsingGET
parameters:
- name: offset
in: query
description: Integer offset for paging
schema:
type: integer
format: int32
- name: maxReturn
in: query
description: Maximum number of channels to return. Max 200, default 20
schema:
type: integer
format: int32
- name: status
in: query
description: Status filter for draft or approved versions
schema:
type: string
enum:
- approved
- draft
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfEmailTemplateResponse'
post:
tags:
- Assets
summary: Marketo Create Email Template
description: 'Creates a new email template. Required Permissions: Read-Write Assets'
operationId: createEmailTemplateUsingPOST
requestBody:
description: createEmailTemplateRequest
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/CreateEmailTemplateRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfEmailTemplateResponse'
x-codegen-request-body-name: createEmailTemplateRequest
/rest/asset/v1/emailTemplates/{id}/usedBy.json:
get:
tags:
- Assets
summary: Marketo Get Email Template Used By
description: 'Returns a list of email records which depend on a given email template. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getEmailTemplateUsedByUsingGET
parameters:
- name: id
in: path
description: Id of the email template
required: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Integer offset for paging
schema:
type: integer
format: int32
- name: maxReturn
in: query
description: Maximum number of channels to return. Max 200, default 20
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfEmailTemplateUsedByResponse'
/rest/asset/v1/emails.json:
get:
tags:
- Assets
summary: Marketo Get Emails
description: 'Returns a list of emails matching the given filter parameters. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getEmailUsingGET
parameters:
- name: status
in: query
description: Status filter for draft or approved versions
schema:
type: string
enum:
- approved
- draft
- name: folder
in: query
description: JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'
schema:
type: string
- name: offset
in: query
description: Integer offset for paging
schema:
type: integer
format: int32
- name: maxReturn
in: query
description: Maximum number of emails to return. Max 200, default 20
schema:
type: integer
format: int32
- name: earliestUpdatedAt
in: query
description: Exclude emails prior to this date. Must be valid ISO-8601 string. See Datetime field type description.
schema:
type: string
- name: latestUpdatedAt
in: query
description: Exclude emails after this date. Must be valid ISO-8601 string. See Datetime field type description.
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfEmailResponse'
post:
tags:
- Assets
summary: Marketo Create Email
description: 'Creates a new email asset. Required Permissions: Read-Write Assets'
operationId: createEmailUsingPOST
requestBody:
description: createEmailRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CreateEmailRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfEmailResponse'
x-codegen-request-body-name: createEmailRequest
/rest/asset/v1/email/{id}/fullContent.json:
get:
tags:
- Assets
summary: Marketo Get Email Full Content
description: '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.'
operationId: getEmailFullContentUsingGET
parameters:
- name: id
in: path
description: Id of the email
required: true
schema:
type: integer
format: int32
- name: status
in: query
description: Status filter for draft or approved versions. Defaults to approved if asset is approved, draft if not.
schema:
type: string
enum:
- approved
- draft
- name: leadId
in: query
description: The lead id to impersonate. Email is rendered as though it was received by this lead.
schema:
type: integer
format: int32
- name: type
in: query
description: Email content type to return. Default is HTML.
schema:
type: string
enum:
- Text
- HTML
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfGetEmailFullContentResponse'
post:
tags:
- Assets
summary: Marketo Update Email Full Content
description: 'Replaces the HTML of an Email that has had its relationship broken from its template. Required Permissions: Read-Write Assets'
operationId: createEmailFullContentUsingPOST
parameters:
- name: id
in: path
description: Id of the email
required: true
schema:
type: integer
format: int32
requestBody:
description: Content is multipart file parameter
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/UpdateEmailFullContentRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfUpdateEmailFullContentResponse'
x-codegen-request-body-name: updateEmailFullContentRequest
/rest/asset/v1/file/byName.json:
get:
tags:
- Assets
summary: Marketo Get File by Name
description: 'Returns files records for the given name. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getFileByNameUsingGET
parameters:
- name: name
in: query
description: Name of the file
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfFileResponse'
/rest/asset/v1/file/{id}.json:
get:
tags:
- Assets
summary: Marketo Get File by Id
description: 'Returns the file record for the given id. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getFileByIdUsingGET
parameters:
- name: id
in: path
description: Id for file in database
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfFileResponse'
/rest/asset/v1/file/{id}/content.json:
post:
tags:
- Assets
summary: Marketo Update File Content
description: 'Replaces the current content of the file with the included payload. Required Permissions: Read-Write Assets'
operationId: updateContentUsingPOST
parameters:
- name: id
in: path
description: Id for file in database
required: true
schema:
type: integer
format: int32
requestBody:
description: request
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/UpdateFileContentRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfFileResponse'
x-codegen-request-body-name: request
/rest/asset/v1/files.json:
get:
tags:
- Assets
summary: Marketo Get Files
description: 'Returns the files from the given folder. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getFilesUsingGET
parameters:
- name: folder
in: query
description: JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'
schema:
type: string
- name: offset
in: query
description: Integer offset for paging. Default 0
schema:
type: integer
format: int32
- name: maxReturn
in: query
description: Maximum number of files to return. Max 200, default 20
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfFileResponse'
post:
tags:
- Assets
summary: Marketo Create File
description: 'Creates a new file from the included payload. Required Permissions: Read-Write Assets'
operationId: createFileUsingPOST
requestBody:
description: createFileRequest
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/CreateFileRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfFileResponse'
x-codegen-request-body-name: createFileRequest
/rest/asset/v1/folder/byName.json:
get:
tags:
- Assets
summary: Marketo Get Folder by Name
description: 'Returns a folder record for the given name. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getFolderByNameUsingGET
parameters:
- name: name
in: query
description: Name of the folder. Not applicable for Programs
required: true
schema:
type: string
- name: type
in: query
description: Type of folder. 'Folder' or 'Program'
schema:
type: string
- name: root
in: query
description: Parent folder reference
schema:
type: string
- name: workSpace
in: query
description: Name of the workspace
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfFolderResponse'
/rest/asset/v1/folder/{id}.json:
get:
tags:
- Assets
summary: Marketo Get Folder by Id
description: 'Returns the folder record with the given id. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getFolderByIdUsingGET
parameters:
- name: id
in: path
description: Id of the folder to retrieve
required: true
schema:
type: integer
format: int32
- name: type
in: query
description: Type of folder. 'Folder' or 'Program'
required: true
schema:
type: string
default: Folder
enum:
- Folder
- Program
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfFolderResponse'
post:
tags:
- Assets
summary: Marketo Update Folder Metadata
description: 'Updates the metadata for a given folder. Required Permissions: Read-Write Assets'
operationId: updateFolderUsingPOST
parameters:
- name: id
in: path
description: Id of the folder to update
required: true
schema:
type: integer
format: int32
requestBody:
description: updateFolderRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/UpdateFolderRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfFolderResponse'
x-codegen-request-body-name: updateFolderRequest
/rest/asset/v1/folder/{id}/content.json:
get:
tags:
- Assets
summary: Marketo Get Folder Contents
description: 'Returns records for the contents of a given folder. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getFolderContentUsingGET
parameters:
- name: id
in: path
description: Id of the folder to retrieve
required: true
schema:
type: integer
format: int32
- name: maxReturn
in: query
description: Maximum number of channels to return. Max 200, default 20
schema:
type: integer
format: int32
- name: offset
in: query
description: Integer offset for paging
schema:
type: integer
format: int32
- name: type
in: query
description: Type of folder. 'Folder' or 'Program'. Default is 'Folder'
required: true
schema:
type: string
enum:
- Folder
- Program
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfFolderContentResponse'
/rest/asset/v1/folder/{id}/delete.json:
post:
tags:
- Assets
summary: Marketo Delete Folder
description: 'Deletes the designated folder. Deletion will fail if the folder has content. Required Permissions: Read-Write Assets'
operationId: deleteFolderUsingPOST
parameters:
- name: id
in: path
description: Id of the folder to delete
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/x-www-form-urlencoded:
schema:
required:
- type
type: object
properties:
type:
type: string
description: type
default: Folder
enum:
- Program
- Folder
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
/rest/asset/v1/folder/{id}/tokens.json:
get:
tags:
- Assets
summary: Marketo Get Tokens by Folder Id
description: 'Retrieves the list of available My Tokens in the target folder. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getTokensByFolderIdUsingGET
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
- name: folderType
in: query
description: Type of folder. 'Folder' or 'Program'
schema:
type: string
default: Folder
enum:
- Folder
- Program
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfTokenResponse'
post:
tags:
- Assets
summary: Marketo Create Token
description: 'Create or update a token in the parent folder. Required Permissions: Read-Write Assets'
operationId: addTokenTOFolderUsingPOST
parameters:
- name: id
in: path
description: Id of the folder to which the token will be associated with
required: true
schema:
type: integer
format: int32
requestBody:
description: createTokenRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CreateTokenRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfTokenResponse'
x-codegen-request-body-name: createTokenRequest
/rest/asset/v1/folder/{id}/tokens/delete.json:
post:
tags:
- Assets
summary: Marketo Delete Token by Name
description: 'Deletes a token with the given name from the parent folder. Required Permissions: Read-Write Assets'
operationId: deleteTokenByNameUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
requestBody:
description: deleteTokenRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/DeleteTokenRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
x-codegen-request-body-name: deleteTokenRequest
/rest/asset/v1/folders.json:
get:
tags:
- Assets
summary: Marketo Get Folders
description: 'Retrieves child folders from within a given root folder. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getFolderUsingGET
parameters:
- name: root
in: query
description: Parent folder reference
schema:
type: string
- name: maxDepth
in: query
description: Maximum folder depth to traverse, Default 2
schema:
type: integer
format: int32
- name: maxReturn
in: query
description: Maximum number of folders to return. Default 20, maximum 200
schema:
type: integer
format: int32
- name: offset
in: query
description: Integer offset for paging. Default 0
schema:
type: integer
format: int32
- name: workSpace
in: query
description: Name of the workspace
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfFolderResponse'
post:
tags:
- Assets
summary: Marketo Create Folder
description: 'Creates a new folder. Required Permissions: Read-Write Assets'
operationId: createFolderUsingPOST
requestBody:
description: createFolderRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CreateFolderRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfFolderResponse'
x-codegen-request-body-name: createFolderRequest
/rest/asset/v1/form/byName.json:
get:
tags:
- Assets
summary: Marketo Get Form by Name
description: 'Retrieves a form record by its name. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getLpFormByNameUsingGET
parameters:
- name: name
in: query
description: Name of the form
required: true
schema:
type: string
- name: status
in: query
description: Status filter for draft or approved versions
schema:
type: string
enum:
- approved
- draft
- name: folder
in: query
description: JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLpFormResponse'
/rest/asset/v1/form/fields.json:
get:
tags:
- Assets
summary: Marketo Get Available Form Fields
description: 'Retrieves a list of all valid fields for use in forms. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getAllFieldsUsingGET
parameters:
- name: maxReturn
in: query
description: Maximum number of fields to return. Max 200, default 20
schema:
type: integer
format: int32
- name: offset
in: query
description: Integer offset for paging
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfFieldsMetaDataResponse'
/rest/asset/v1/form/programMemberFields.json:
get:
tags:
- Assets
summary: Marketo Get Available Form Program Member Fields
description: 'Retrieves a list of all valid Program Member fields for use in forms. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getAllProgramMemberFieldsUsingGET
parameters:
- name: maxReturn
in: query
description: Maximum number of fields to return. Max 200, default 20
schema:
type: integer
format: int32
- name: offset
in: query
description: Integer offset for paging
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfFieldsMetaDataResponse'
/rest/asset/v1/form/{formId}/field/{fieldId}/visibility.json:
post:
tags:
- Assets
summary: Marketo Add Form Field Visibility Rules
description: 'Adds a visibility rule to the target form field. Required Permissions: Read-Write Assets'
operationId: addFormFieldVisibilityRuleUsingPOST
parameters:
- name: formId
in: path
description: formId
required: true
schema:
type: integer
format: int32
- name: fieldId
in: path
description: fieldId
required: true
schema:
type: string
requestBody:
description: addFormFieldVisibilityRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/AddFormFieldVisibilityRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfFormVisibilityRuleResponse'
x-codegen-request-body-name: addFormFieldVisibilityRequest
/rest/asset/v1/form/{id}.json:
get:
tags:
- Assets
summary: Marketo Get Form By Id
description: 'Retrieves a form record by its id. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getLpFormByIdUsingGET
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
- name: status
in: query
description: Status filter for draft or approved versions
schema:
type: string
enum:
- approved
- draft
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLpFormResponse'
post:
tags:
- Assets
summary: Marketo Update Form Metadata
description: 'Updates the metadata of the target form. Required Permissions: Read-Write Assets'
operationId: updateFormsUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
requestBody:
description: updateFormMetaDataRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/UpdateFormMetaDataRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLpFormResponse'
x-codegen-request-body-name: updateFormMetaDataRequest
/rest/asset/v1/form/{id}/approveDraft.json:
post:
tags:
- Assets
summary: Marketo Approve Form Draft
description: 'Approves the current draft of the form. This will delete the current approved version of the form. Required Permissions: Approve Assets'
operationId: approveFromUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLpFormResponse'
/rest/asset/v1/form/{id}/clone.json:
post:
tags:
- Assets
summary: Marketo Clone Form
description: 'Clones the target form. Required Permissions: Read-Write Assets'
operationId: cloneLpFormsUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
requestBody:
description: cloneFormRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CloneFormRequest'
required: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLpFormResponse'
x-codegen-request-body-name: cloneFormRequest
/rest/asset/v1/form/{id}/delete.json:
post:
tags:
- Assets
summary: Marketo Delete Form
description: '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'
operationId: deleteFormByIdUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
/rest/asset/v1/form/{id}/discardDraft.json:
post:
tags:
- Assets
summary: Marketo Discard Form Draft
description: 'Discards the current draft of the form. Required Permissions: Read-Write Assets'
operationId: discardFormByIdUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
/rest/asset/v1/form/{id}/field/{fieldId}.json:
post:
tags:
- Assets
summary: Marketo Update Form Field
description: 'Updates the configuration for that target field. Required Permissions: Read-Write Assets'
operationId: updateFormFieldUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
- name: fieldId
in: path
description: fieldId
required: true
schema:
type: string
requestBody:
description: updateFormFieldRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/UpdateFormFieldRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLpFormFieldResponse'
x-codegen-request-body-name: updateFormFieldRequest
/rest/asset/v1/form/{id}/field/{fieldId}/delete.json:
post:
tags:
- Assets
summary: Marketo Delete Form Field
description: 'Deletes a field from a form. Required Permissions: Read-Write Assets'
operationId: deleteFormFieldUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
- name: fieldId
in: path
description: fieldId
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
/rest/asset/v1/form/{id}/fieldSet.json:
post:
tags:
- Assets
summary: Marketo Add Fieldset to Form
description: 'Adds a field set to the target form. Required Permissions: Read-Write Assets'
operationId: addFieldSetUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
requestBody:
description: addFormFieldSetRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/AddFormFieldSetRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLpFormFieldResponse'
x-codegen-request-body-name: addFormFieldSetRequest
/rest/asset/v1/form/{id}/fieldSet/{fieldSetId}/field/{fieldId}/delete.json:
post:
tags:
- Assets
summary: Marketo Delete Field from Fieldset
description: 'Removes the target field from the fieldset. Required Permissions: Read-Write Assets'
operationId: deleteFormFieldFromFieldSetUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
- name: fieldSetId
in: path
description: fieldSetId
required: true
schema:
type: string
- name: fieldId
in: path
description: fieldId
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
/rest/asset/v1/form/{id}/fields.json:
get:
tags:
- Assets
summary: Marketo Get Fields for Form
description: 'Retrieves the list of fields in the target form. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getFormFieldByFormVidUsingGET
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
- name: status
in: query
description: Status filter for draft or approved versions
schema:
type: string
enum:
- approved
- draft
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLpFormFieldResponse'
post:
tags:
- Assets
summary: Marketo Add Field to Form
description: 'Adds a field to a form. Required Permissions: Read-Write Assets'
operationId: addFieldToAFormUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
requestBody:
description: addFormFieldSetRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/AddFormFieldRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLpFormFieldResponse'
x-codegen-request-body-name: addFormFieldSetRequest
/rest/asset/v1/form/{id}/reArrange.json:
post:
tags:
- Assets
summary: Marketo Update Field Positions
description: 'Reorders the list of fields in a form. Required Permissions: Read-Write Assets'
operationId: updateFieldPositionsUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
requestBody:
description: reArrangeRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ReArrangeRequest'
required: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
x-codegen-request-body-name: reArrangeRequest
/rest/asset/v1/form/{id}/richText.json:
post:
tags:
- Assets
summary: Marketo Add Rich Text Field
description: 'Adds a rich-text type field to the form. Required Permissions: Read-Write Assets'
operationId: addRichTextFieldUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
requestBody:
description: addRichTextRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/AddRichTextRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLpFormFieldResponse'
x-codegen-request-body-name: addRichTextRequest
/rest/asset/v1/form/{id}/submitButton.json:
post:
tags:
- Assets
summary: Marketo Update Submit Button
description: 'Updates the submit button configuration for the target form. Required Permissions: Read-Write Assets'
operationId: updateFormSubmitButtonUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
requestBody:
description: submitButtonRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SubmitButtonRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLpFormResponse'
x-codegen-request-body-name: submitButtonRequest
/rest/asset/v1/form/{id}/thankYouPage.json:
get:
tags:
- Assets
summary: Marketo Get Thank You Page by Form Id
description: 'Returns the thank you page configuration for a given form. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getThankYouPageByIdUsingGET
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
- name: status
in: query
description: Status filter for draft or approved versions
schema:
type: string
enum:
- approved
- draft
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfThankYouPageResponse'
post:
tags:
- Assets
summary: Marketo Update Thank You Page
description: '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'
operationId: updateThankYouPageByIdUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
requestBody:
description: thankYouPageRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/UpdateThankYouPageRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfThankYouPageResponse'
x-codegen-request-body-name: thankYouPageRequest
/rest/asset/v1/forms.json:
get:
tags:
- Assets
summary: Marketo Get Forms
description: 'Retrieves a list of accessible form records from the target instance. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: browseForms2UsingGET
parameters:
- name: status
in: query
description: Status filter for draft or approved versions
schema:
type: string
enum:
- approved
- draft
- name: folder
in: query
description: JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'
required: true
schema:
type: string
- name: maxReturn
in: query
description: Maximum number of channels to return. Max 200, default 20
schema:
type: string
- name: offset
in: query
description: Integer offset for paging
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLpFormResponse'
post:
tags:
- Assets
summary: Marketo Create Form
description: 'Creates a new form. Required Permissions: Read-Write Assets'
operationId: createLpFormsUsingPOST
requestBody:
description: createFormRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CreateLpFormRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLpFormResponse'
x-codegen-request-body-name: createFormRequest
/rest/asset/v1/form/{id}/usedBy.json:
get:
tags:
- Assets
summary: Marketo Get Form Used By
description: 'Returns a list of asset records which depend on a given form. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getFormUsedByUsingGET
parameters:
- name: id
in: path
description: Id of the form
required: true
schema:
type: integer
format: int32
- name: offset
in: query
description: Integer offset for paging
schema:
type: integer
format: int32
- name: maxReturn
in: query
description: Maximum number of assets to return. Max 200, default 20
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfFormUsedByResponse'
/rest/asset/v1/landingPage/byName.json:
get:
tags:
- Assets
summary: Marketo Get Landing Page by Name
description: 'Returns the landing page record for the given name. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getLandingPageByNameUsingGET
parameters:
- name: name
in: query
description: Name of the landing page
required: true
schema:
type: string
- name: status
in: query
description: Status filter for draft or approved versions
schema:
type: string
enum:
- approved
- draft
- name: maxReturn
in: query
description: Maximum number of channels to return. Max 200, default 20
schema:
type: integer
format: int32
- name: offset
in: query
description: Integer offset for paging
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLandingPageResponse'
/rest/asset/v1/landingPage/{id}.json:
get:
tags:
- Assets
summary: Marketo Get Landing Page by Id
description: 'Returns the landing record for the given id. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getLandingPageByIdUsingGET
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
- name: status
in: query
description: Status filter for draft or approved versions
schema:
type: string
enum:
- approved
- draft
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLandingPageResponse'
post:
tags:
- Assets
summary: Marketo Update Landing Page Metadata
description: 'Updates the metadata for the targe landing page. Required Permissions: Read-Write Assets'
operationId: updateLandingPageUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
requestBody:
description: updateLandingPageRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/UpdateLandingPageRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLandingPageResponse'
x-codegen-request-body-name: updateLandingPageRequest
/rest/asset/v1/landingPage/{id}/approveDraft.json:
post:
tags:
- Assets
summary: Marketo Approve Landing Page Draft
description: 'Approves the current draft of the landing page. Required Permissions: Approve Assets'
operationId: approveLandingPageUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
/rest/asset/v1/landingPage/{id}/clone.json:
post:
tags:
- Assets
summary: Marketo Clone Landing Page
description: 'Clones the target landing page. Required Permissions: Read-Write Assets'
operationId: cloneLandingPageUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
requestBody:
description: cloneLandingPageRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CloneLandingPageRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLandingPageResponse'
x-codegen-request-body-name: cloneLandingPageRequest
/rest/asset/v1/landingPage/{id}/content.json:
get:
tags:
- Assets
summary: Marketo Get Landing Page Content
description: 'Retrieves the list of content sections in the target landing page. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getLandingPageContentUsingGET
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
- name: status
in: query
description: Status filter for draft or approved versions
schema:
type: string
enum:
- approved
- draft
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLandingPageContentResponse'
post:
tags:
- Assets
summary: Marketo Add Landing Page Content Section
description: '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'
operationId: addLandingPageContentUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
requestBody:
description: request
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CreateLandingPageContentRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
x-codegen-request-body-name: request
/rest/asset/v1/landingPage/{id}/content/{contentId}.json:
post:
tags:
- Assets
summary: Marketo Update Landing Page Content Section
description: 'Updates a content section the landing page. Parameters must be sent as application/x-www-form-urlencoded (not JSON). Required Permissions: Read-Write Assets'
operationId: updateLandingPageContentUsingPOST
parameters:
- name: id
in: path
description: Id of landing page
required: true
schema:
type: integer
format: int32
- name: contentId
in: path
description: Id of landing page content section
required: true
schema:
type: string
requestBody:
description: Content properties
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/UpdateLandingPageContentRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
x-codegen-request-body-name: request
/rest/asset/v1/landingPage/{id}/content/{contentId}/delete.json:
post:
tags:
- Assets
summary: Marketo Delete Landing Page Content Section
description: 'Removes the target content section from the parent landing page. Required Permissions: Read-Write Assets'
operationId: removeLandingPageContentUsingPOST
parameters:
- name: id
in: path
description: Id of landing page
required: true
schema:
type: integer
format: int32
- name: contentId
in: path
description: Id of landing page content section
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
/rest/asset/v1/landingPage/{id}/delete.json:
post:
tags:
- Assets
summary: Marketo Delete Landing Page
description: 'Deletes the target landing page. Required Permissions: Read-Write Assets'
operationId: deleteLandingPageByIdUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
/rest/asset/v1/landingPage/{id}/discardDraft.json:
post:
tags:
- Assets
summary: Marketo Discard Landing Page Draft
description: 'Discards the current draft of the landing page. Required Permissions: Read-Write Assets'
operationId: discardLandingPageByIdUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
/rest/asset/v1/landingPage/{id}/dynamicContent/{contentId}.json:
get:
tags:
- Assets
summary: Marketo Get Landing Page Dynamic Content
description: 'Retrieves the dynamic content from the target section. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getLandingPageDynamicContentsUsingGET
parameters:
- name: id
in: path
description: Id of landing page
required: true
schema:
type: integer
format: int32
- name: contentId
in: path
description: Id of landing page dynamic content section
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLandingPageDynamicContentResponse'
post:
tags:
- Assets
summary: Marketo Update Landing Page Dynamic Content Section
description: 'Updates the content of the target dynamic content section. Required Permissions: Read-Write Assets'
operationId: updateLandingPageDynamicContentUsingPOST
parameters:
- name: id
in: path
description: Id of the landing page
required: true
schema:
type: integer
format: int32
- name: contentId
in: path
description: Id of the landing page dynamic content
required: true
schema:
type: string
requestBody:
description: Dynamic content properties
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/UpdateLandingPageDynamicContentRequest'
required: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
x-codegen-request-body-name: request
/rest/asset/v1/landingPage/{id}/unapprove.json:
post:
tags:
- Assets
summary: Marketo Unapprove Landing Page
description: 'Unapproves the landing page, reverting it to a draft-only state. Required Permissions: Approve Assets'
operationId: unapproveLandingPageByIdUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLandingPageResponse'
/rest/asset/v1/landingPage/{id}/variable/{variableId}.json:
post:
tags:
- Assets
summary: Marketo Update Landing Page Variable
description: 'Updates the value of the given variable. Required Permissions: Read-Write Assets'
operationId: updateLandingPageVariableUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
- name: variableId
in: path
description: variableId
required: true
schema:
type: string
- name: value
in: query
description: New value of the variable
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLandingPageVariableResponse'
/rest/asset/v1/landingPage/{id}/variables.json:
get:
tags:
- Assets
summary: Marketo Get Landing Page Variables
operationId: getVariablesUsingGET
parameters:
- name: id
in: path
description: Id of the landing page
required: true
schema:
type: integer
format: int32
- name: status
in: query
description: Status filter for draft or approved versions
schema:
type: string
enum:
- approved
- draft
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLandingPageVariableResponse'
/rest/asset/v1/landingPageTemplate/byName.json:
get:
tags:
- Assets
summary: Marketo Get Landing Page Template by Name
description: 'Retrieves the landing page template record for the given name. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getLandingPageTemplateByNameUsingGET
parameters:
- name: name
in: query
description: Name of the landing page template
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLpTemplateResponse'
/rest/asset/v1/landingPageTemplate/{id}.json:
get:
tags:
- Assets
summary: Marketo Get Landing Page Template by Id
description: 'Retrieves the record for the target landing page template. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getLandingPageTemplateByIdUsingGET
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
- name: status
in: query
description: Status filter for draft or approved versions
schema:
type: string
enum:
- approved
- draft
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLpTemplateResponse'
post:
tags:
- Assets
summary: Marketo Update Landing Page Template Metadata
description: 'Updates the metadata for the target landing page template. Required Permissions: Read-Write Assets'
operationId: updateLpTemplateUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
requestBody:
description: updateLpTemplateRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/UpdateLpTemplateRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLpTemplateResponse'
x-codegen-request-body-name: updateLpTemplateRequest
/rest/asset/v1/landingPageTemplate/{id}/approveDraft.json:
post:
tags:
- Assets
summary: Marketo Approve Landing Page Template Draft
description: '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'
operationId: approveLandingPageTemplateUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLpTemplateResponse'
/rest/asset/v1/landingPageTemplate/{id}/clone.json:
post:
tags:
- Assets
summary: Marketo Clone Landing Page Template
description: 'Clones the target landing page template. Required Permissions: Read-Write Assets'
operationId: cloneLpTemplateUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
requestBody:
description: cloneLpTemplateRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CloneLpTemplateRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLpTemplateResponse'
x-codegen-request-body-name: cloneLpTemplateRequest
/rest/asset/v1/landingPageTemplate/{id}/content.json:
get:
tags:
- Assets
summary: Marketo Get Landing Page Template Content
description: 'Retrieves the content of the target landing page. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getLandingPageTemplateContentUsingGET
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
- name: status
in: query
description: Status filter for draft or approved versions
schema:
type: string
enum:
- approved
- draft
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLpTemplateGetContentResponse'
post:
tags:
- Assets
summary: Marketo Update Landing Page Template Content
description: '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'
operationId: updateLandingPageTemplateContentUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
requestBody:
content:
multipart/form-data:
schema:
required:
- content
type: object
properties:
content:
type: string
description: content
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
/rest/asset/v1/landingPageTemplate/{id}/delete.json:
post:
tags:
- Assets
summary: Marketo Delete Landing Page Template
description: 'Deletes the target landing page template. Required Permissions: Read-Write Assets'
operationId: deleteLpTemplateUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
/rest/asset/v1/landingPageTemplate/{id}/discardDraft.json:
post:
tags:
- Assets
summary: Marketo Discard Landing Page Template Draft
description: 'Discrads the current draft of the landing page template. Required Permissions: Read-Write Assets'
operationId: discardDraftUsingPOST_2
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
/rest/asset/v1/landingPageTemplate/{id}/unapprove.json:
post:
tags:
- Assets
summary: Marketo Unapprove Landing Page Template
description: 'Unapproves the landing page template and reverts it to a draft-only state. Required Permissions: Approve Assets'
operationId: unapproveLandingPageTemplateUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLpTemplateResponse'
/rest/asset/v1/landingPageTemplates.json:
get:
tags:
- Assets
summary: Marketo Get Landing Page Templates
description: 'Retrieves the list of accessible landing page templates from the target instance. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getLandingPageTemplatesUsingGET
parameters:
- name: maxReturn
in: query
description: Maximum number of channels to return. Max 200, default 20
schema:
type: integer
format: int32
- name: offset
in: query
description: Integer offset for paging
schema:
type: integer
format: int32
- name: status
in: query
description: Status filter for draft or approved versions
schema:
type: string
enum:
- approved
- draft
- name: folder
in: query
description: JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLpTemplateResponse'
post:
tags:
- Assets
summary: Marketo Create Landing Page Template
description: 'Creates a new landing page template. Required Permissions: Read-Write Assets'
operationId: createLpTemplateUsingPOST
requestBody:
description: createLpTemplateRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CreateLpTemplateRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLpTemplateResponse'
x-codegen-request-body-name: createLpTemplateRequest
/rest/asset/v1/landingPages.json:
get:
tags:
- Assets
summary: Marketo Get Landing Pages
description: 'Retrieves a list of accessible landing pages from the target instance. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: browseLandingPagesUsingGET
parameters:
- name: status
in: query
description: Status filter for draft or approved versions
schema:
type: string
enum:
- approved
- draft
- name: maxReturn
in: query
description: Maximum number of landing pages to return. Max 200, default 20
schema:
type: integer
format: int32
- name: offset
in: query
description: Integer offset for paging
schema:
type: integer
format: int32
- name: folder
in: query
description: JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLandingPageResponse'
post:
tags:
- Assets
summary: Marketo Create Landing Page
description: 'Creates a new landing page. Required Permissions: Read-Write Assets'
operationId: createLandingPageUsingPOST
requestBody:
description: createLandingPageRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CreateLandingPageRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLandingPageResponse'
x-codegen-request-body-name: createLandingPageRequest
/rest/asset/v1/landingPage/{id}/fullContent.json:
get:
tags:
- Assets
summary: Marketo Get Landing Page Full Content
description: '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.'
operationId: getLandingPageFullContentUsingGET
parameters:
- name: id
in: path
description: Id of the landing page.
required: true
schema:
type: integer
format: int32
- name: leadId
in: query
description: The lead id to impersonate. Landing page is rendered as though it was viewed by this lead.
schema:
type: integer
format: int32
- name: segmentation
in: query
description: 'JSON array of of segmentations. Each segmentation must be a JSON object with members ''segmentationId'', and ''segmentId''.
Example: [{"segmentationId":1030,"segmentId":1103}]'
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfGetLandingPageFullContentResponse'
/rest/asset/v1/redirectRules.json:
get:
tags:
- Assets
summary: Marketo Get Landing Page Redirect Rules
description: 'Retrieves a list of landing page redirect rules from the target instance. Required Permissions: Read Only Redirect Rules, Read Write Redirect Rules'
operationId: getLandingPageRedirectRulesUsingGET
parameters:
- name: maxReturn
in: query
description: Maximum number of landing page redirect rules to return. Max 200, default 20
schema:
type: integer
format: int32
- name: offset
in: query
description: Integer offset for paging
schema:
type: integer
format: int32
- name: redirectTolandingPageId
in: query
description: Landing page id of landing page to redirect to
schema:
type: string
- name: redirectToPath
in: query
description: Path of landing page to redirect to
schema:
type: string
- name: earliestUpdatedAt
in: query
description: Exclude landing page redirect rules prior to this date. Must be valid ISO-8601 string. See Datetime field type description.
schema:
type: string
- name: latestUpdatedAt
in: query
description: Exclude landing page redirect rules after this date. Must be valid ISO-8601 string. See Datetime field type description.
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLandingPageRedirectRules'
post:
tags:
- Assets
summary: Marketo Create Landing Page Redirect Rule
description: 'Create a new landing page redirect rule. Required Permissions: Read Write Redirect Rules'
operationId: createLandingPageRedirectRuleUsingPOST
requestBody:
description: createLandingPageRedirectRuleRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CreateLandingPageRedirectRuleRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLandingPageRedirectRules'
x-codegen-request-body-name: createLandingPageRedirectRuleRequest
/rest/asset/v1/redirectRule/{id}.json:
get:
tags:
- Assets
summary: Marketo Get Landing Page Redirect Rule by Id
description: 'Retrieves the landing page redirect rule record. Required Permissions: Read Only Redirect Rules, Read Write Redirect Rules'
operationId: getLandingPageRedirectRuleByIdUsingGET
parameters:
- name: id
in: path
description: Id of landing page redirect rule
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLandingPageRedirectRules'
post:
tags:
- Assets
summary: Marketo Update Landing Page Redirect Rule
description: 'Update an existing landing page redirect rule. Required Permissions: Read Write Redirect Rules'
operationId: updateLandingPageRedirectRuleUsingPOST
parameters:
- name: id
in: path
description: Id of landing page redirect rule
required: true
schema:
type: integer
format: int32
requestBody:
description: updateLandingPageRedirectRuleRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/UpdateLandingPageRedirectRuleRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLandingPageRedirectRules'
x-codegen-request-body-name: updateLandingPageRedirectRuleRequest
/rest/asset/v1/redirectRule/{id}/delete.json:
post:
tags:
- Assets
summary: Marketo Delete Landing Page Redirect Rule
description: 'Delete a landing page redirect rule. Required Permissions: Read Write Redirect Rules'
operationId: deleteLandingPageRedirectRuleUsingPOST
parameters:
- name: id
in: path
description: Id of landing page redirect rule
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
/rest/asset/v1/landingPageDomains.json:
get:
tags:
- Assets
summary: Marketo Get Landing Page Domains
description: 'Retrieves a list of landing page domain and domain aliases. Required Permissions: Read Only Redirect Rules, Read Write Redirect Rules'
operationId: getLandingPageDomainsUsingGET
parameters:
- name: maxReturn
in: query
description: Maximum number of landing page domains and domain aliases to return. Max 200, default 20
schema:
type: integer
format: int32
- name: offset
in: query
description: Integer offset for paging
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfLandingPageDomains'
/rest/asset/v1/program/byName.json:
get:
tags:
- Assets
summary: Marketo Get Program by Name
description: 'Retrieves the program record for the given name. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getProgramByNameUsingGET
parameters:
- name: name
in: query
description: Name of the program
required: true
schema:
type: string
- name: includeTags
in: query
description: Set true to populate program tags
schema:
type: boolean
- name: includeCosts
in: query
description: Set true to populate program costs
schema:
type: boolean
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfProgramResponse'
/rest/asset/v1/program/byTag.json:
get:
tags:
- Assets
summary: Marketo Get Programs by Tag
description: 'Retrieves a list of programs matching the tag type and tag values given. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getProgramListByTagUsingGET
parameters:
- name: tagType
in: query
description: Type of program tag
required: true
schema:
type: string
- name: tagValue
in: query
description: Value of the tag
required: true
schema:
type: string
- name: maxReturn
in: query
description: Maximum number of channels to return. Max 200, default 20
schema:
type: integer
format: int32
- name: offset
in: query
description: Integer offset for paging
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfProgramResponse'
/rest/asset/v1/program/{id}.json:
get:
tags:
- Assets
summary: Marketo Get Program by Id
description: 'Retrieves the program record for the given id. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getProgramByIdUsingGET
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfProgramResponse'
post:
tags:
- Assets
summary: Marketo Update Program Metadata
description: 'Updates the target program''s metadata. Required Permissions: Read-Write Assets'
operationId: updateProgramUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
requestBody:
description: updateProgramRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/UpdateProgramRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfProgramResponse'
x-codegen-request-body-name: updateProgramRequest
/rest/asset/v1/program/{programId}/smartList.json:
get:
tags:
- Assets
summary: Marketo Get Smart List by Program Id
description: 'Retrieves a Smart List record by its Email Program id. Required Permissions: Read-Asset or Read-Write Asset'
operationId: getSmartListByProgramIdUsingGET
parameters:
- name: programId
in: path
description: Id for the email program containing smart list to retrieve
required: true
schema:
type: integer
format: int64
- name: includeRules
in: query
description: Set true to populate smart list rules. Default false
schema:
type: boolean
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfSmartListResponseWithRules'
/rest/asset/v1/program/{id}/approve.json:
post:
tags:
- Assets
summary: Marketo Approve Program
description: 'Approves the target program. Only valid for unapproved email programs. Required Permissions: Read-Write Assets'
operationId: approveProgramUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
/rest/asset/v1/program/{id}/clone.json:
post:
tags:
- Assets
summary: Marketo Clone Program
description: 'Clones the target program. Required Permissions: Read-Write Assets'
operationId: cloneProgramUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
requestBody:
description: cloneProgramRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CloneProgramRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfProgramResponse'
x-codegen-request-body-name: cloneProgramRequest
/rest/asset/v1/program/{id}/delete.json:
post:
tags:
- Assets
summary: Marketo Delete Program
description: 'Deletes the target program. The program may not contain any assets which are in use outside the program. Required Permissions: Read-Write Assets'
operationId: deleteProgramUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
/rest/asset/v1/program/{id}/unapprove.json:
post:
tags:
- Assets
summary: Marketo Unapprove Program
description: 'Unapproves the target program. Only valid for approved email programs. Required Permissions: Read-Write Assets'
operationId: unapproveProgramUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
/rest/asset/v1/programs.json:
get:
tags:
- Assets
summary: Marketo Get Programs
description: 'Retrieves the list of accessible programs from the target instance. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: browseProgramsUsingGET
parameters:
- name: maxReturn
in: query
description: Maximum number of channels to return. Max 200, default 20
schema:
type: integer
format: int32
- name: offset
in: query
description: Integer offset for paging
schema:
type: integer
format: int32
- name: filterType
in: query
description: Optional filter. Requires filterValues
schema:
type: string
enum:
- id
- programId
- folderId
- workspace
- name: earliestUpdatedAt
in: query
description: Exclude programs prior to this date. Must be valid ISO-8601 string. See Datetime field type description.
schema:
type: string
- name: latestUpdatedAt
in: query
description: Exclude programs after this date. Must be valid ISO-8601 string. See Datetime field type description.
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfBrowseAllPrograms'
post:
tags:
- Assets
summary: Marketo Create Program
description: 'Creates a new program. Required Permissions: Read-Write Assets'
operationId: createProgramUsingPOST
requestBody:
description: createProgramRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CreateProgramRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfProgramResponse'
x-codegen-request-body-name: createProgramRequest
/rest/asset/v1/segmentation.json:
get:
tags:
- Assets
summary: Marketo Get Segmentations
description: 'Retrieves a list of accessible segmentations for the target instance. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getSegmentationUsingGET
parameters:
- name: status
in: query
description: Status filter for draft or approved versions
schema:
type: string
enum:
- approved
- draft
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfSegmentationResponse'
/rest/asset/v1/segmentation/{id}/segments.json:
get:
tags:
- Assets
summary: Marketo Get Segments For Segmentation
description: 'Retrieves a list of segments inside the target segmentation. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getSegmentsForSegmentationUsingGET
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
- name: status
in: query
description: Status filter for draft or approved versions
schema:
type: string
enum:
- approved
- draft
- name: offset
in: query
description: Integer offset for paging
schema:
type: integer
format: int32
- name: maxReturn
in: query
description: Maximum number of channels to return. Max 200, default 20
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfSegmentsResponse'
/rest/asset/v1/smartCampaign/{id}.json:
get:
tags:
- Assets
summary: Marketo Get Smart Campaign by Id
description: 'Returns the smart campaign for the given id. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getSmartCampaignByIdUsingGET
parameters:
- name: id
in: path
description: Id for the smart campaign
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfSmartCampaignResponse'
post:
tags:
- Assets
summary: Marketo Update Smart Campaign
description: 'Update the smart campaign for the given id. Required Permissions: Read-Write Assets'
operationId: updateSmartCampaignUsingPOST
parameters:
- name: id
in: path
description: Id for the smart campaign
required: true
schema:
type: integer
format: int32
requestBody:
description: updateSmartCampaignRequest
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateSmartCampaignRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfSmartCampaignResponse'
x-codegen-request-body-name: updateSmartCampaignRequest
/rest/asset/v1/smartCampaign/byName.json:
get:
tags:
- Assets
summary: Marketo Get Smart Campaign by Name
description: 'Returns the smart campaign for the given name. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getSmartCampaignByNameUsingGET
parameters:
- name: name
in: query
description: Name for the smart campaign
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfSmartCampaignResponse'
/rest/asset/v1/smartCampaign/{id}/smartList.json:
get:
tags:
- Assets
summary: Marketo Get Smart List by Smart Campaign Id
description: 'Retrieves a Smart List record by its Smart Campaign id. Required Permissions: Read-Asset or Read-Write Asset'
operationId: getSmartListBySmartCampaignIdUsingGET
parameters:
- name: id
in: path
description: Id for the smart campaign containing smart list to retrieve
required: true
schema:
type: integer
format: int64
- name: includeRules
in: query
description: Set true to populate smart list rules. Default false
schema:
type: boolean
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfSmartListResponseWithRules'
/rest/asset/v1/smartCampaigns.json:
get:
tags:
- Assets
summary: Marketo Get Smart Campaigns
description: 'Retrieves all smart campaigns. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getAllSmartCampaignsGET
parameters:
- name: maxReturn
in: query
description: Maximum number of smart campaigns to return. Max 200, default 20
schema:
type: integer
format: int32
- name: offset
in: query
description: Integer offset for paging
schema:
type: integer
format: int32
- name: folder
in: query
description: JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'
schema:
type: string
- name: earliestUpdatedAt
in: query
description: Exclude smart campaigns prior to this date. Must be valid ISO-8601 string. See Datetime field type description.
schema:
type: string
- name: latestUpdatedAt
in: query
description: Exclude smart campaigns after this date. Must be valid ISO-8601 string. See Datetime field type description.
schema:
type: string
- name: isActive
in: query
description: Set true to return only active campaigns. Default false
schema:
type: boolean
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfSmartCampaignResponse'
post:
tags:
- Assets
summary: Marketo Create Smart Campaign
description: 'Creates a new smart campaign. Required Permissions: Read-Write Assets'
operationId: createSmartCampaignUsingPOST
requestBody:
description: createSmartCampaignRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CreateSmartCampaignRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfSmartCampaignResponse'
x-codegen-request-body-name: createSmartCampaignRequest
/rest/asset/v1/smartCampaign/{id}/activate.json:
post:
tags:
- Assets
summary: Marketo Activate Smart Campaign
description: 'Activates a trigger smart campaign. Required Permissions: Activate Campaign'
operationId: activateSmartCampaignUsingPOST
parameters:
- name: id
in: path
description: Id of the smart campaign
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
/rest/asset/v1/smartCampaign/{id}/deactivate.json:
post:
tags:
- Assets
summary: Marketo Deactivate Smart Campaign
description: 'Deactivates a trigger smart campaign. Required Permissions: Deactivate Campaign'
operationId: deactivateSmartCampaignUsingPOST
parameters:
- name: id
in: path
description: Id of the smart campaign
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
/rest/asset/v1/smartCampaign/{id}/clone.json:
post:
tags:
- Assets
summary: Marketo Clone Smart Campaign
description: 'Clones a smart campaign. Required Permissions: Read-Write Assets'
operationId: cloneSmartCampaignUsingPOST
parameters:
- name: id
in: path
description: Id of the smart campaign
required: true
schema:
type: integer
format: int32
requestBody:
description: cloneSmartCampaignRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CloneSmartCampaignRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfSmartCampaignResponse'
x-codegen-request-body-name: cloneSmartCampaignRequest
/rest/asset/v1/smartCampaign/{id}/delete.json:
post:
tags:
- Assets
summary: Marketo Delete Smart Campaign
description: 'Deletes a smart campaign. Required Permissions: Read-Write Assets'
operationId: deleteSmartCampaignUsingPOST
parameters:
- name: id
in: path
description: Id of the smart campaign
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
/rest/asset/v1/snippet/{id}.json:
get:
tags:
- Assets
summary: Marketo Get Snippet by Id
description: 'Retrieves the target snippet record. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getSnippetByIdUsingGET
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
- name: status
in: query
description: Status filter for draft or approved versions
schema:
type: string
enum:
- approved
- draft
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfSnippetResponse'
post:
tags:
- Assets
summary: Marketo Update Snippet Metadata
description: 'Updates the metadata of the snippet. Required Permissions: Read-Write Assets'
operationId: updateSnippetUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
requestBody:
description: updateSnippetRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/UpdateSnippetRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfSnippetResponse'
x-codegen-request-body-name: updateSnippetRequest
/rest/asset/v1/snippet/{id}/approveDraft.json:
post:
tags:
- Assets
summary: Marketo Approve Snippet Draft
description: 'Approves the current draft of the snippet. Required Permissions: Approve Assets'
operationId: approveSnippetUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfSnippetResponse'
/rest/asset/v1/snippet/{id}/clone.json:
post:
tags:
- Assets
summary: Marketo Clone Snippet
description: 'Clones the target snippet. Required Permissions: Read-Write Assets'
operationId: cloneSnippetUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
requestBody:
description: cloneSnippetRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CloneSnippetRequest'
required: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfSnippetResponse'
x-codegen-request-body-name: cloneSnippetRequest
/rest/asset/v1/snippet/{id}/content.json:
get:
tags:
- Assets
summary: Marketo Get Snippet Content
description: 'Retrieves the content of the target snippet. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getSnippetContentByIdUsingGET
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
- name: status
in: query
description: Status filter for draft or approved versions
schema:
type: string
enum:
- approved
- draft
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfSnippetContentResponse'
post:
tags:
- Assets
summary: Marketo Update Snippet Content
description: 'Updates the content of the target snippet. Required Permissions: Read-Write Assets'
operationId: updateContentUsingPOST_1
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
- name: content
in: query
description: Content of the snippet
required: true
schema:
type: string
- name: type
in: query
description: Type of snippet content
required: true
schema:
type: string
enum:
- DynamicContent
- HTML
- Text
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
/rest/asset/v1/snippet/{id}/delete.json:
post:
tags:
- Assets
summary: Marketo Delete Snippet
description: 'Deletes the target snippet. The snippet may not be in use by emails or landing pages. Required Permissions: Read-Write Assets'
operationId: deleteSnippetUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
/rest/asset/v1/snippet/{id}/discardDraft.json:
post:
tags:
- Assets
summary: Marketo Discard Snippet Draft
description: 'Discards the current draft of the snippet. Required Permissions: Read-Write Assets'
operationId: discardSnippetUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
/rest/asset/v1/snippet/{id}/dynamicContent.json:
get:
tags:
- Assets
summary: Marketo Get Dynamic Content
description: 'Gets the list of dynamic content sections for the snippet. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getDynamicContentUsingGET
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
- name: status
in: query
description: Status filter for draft or approved versions
schema:
type: string
enum:
- approved
- draft
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ModelResponse'
/rest/asset/v1/snippet/{id}/dynamicContent/{segmentId}.json:
post:
tags:
- Assets
summary: Marketo Update Snippet Dynamic Content
description: 'Updates the target dynamic content section. Required Permissions: Read-Write Assets'
operationId: updateDynamicContentUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
- name: segmentId
in: path
description: segmentId
required: true
schema:
type: integer
format: int32
requestBody:
description: request
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/UpdateSnippetDynamicContentRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
x-codegen-request-body-name: request
/rest/asset/v1/snippet/{id}/unapprove.json:
post:
tags:
- Assets
summary: Marketo Unapprove Snippet
description: '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'
operationId: unapproveSnippetUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfSnippetResponse'
/rest/asset/v1/snippets.json:
get:
tags:
- Assets
summary: Marketo Get Snippets
description: 'Retrieves a list of accessible snippets from the target instance. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getSnippetUsingGET
parameters:
- name: status
in: query
description: Status filter for draft or approved versions
schema:
type: string
enum:
- approved
- draft
- name: maxReturn
in: query
description: Maximum number of channels to return. Max 200, default 20
schema:
type: integer
format: int32
- name: offset
in: query
description: Integer offset for paging
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfSnippetResponse'
post:
tags:
- Assets
summary: Marketo Create Snippet
description: 'Creates a new snippet. Required Permissions: Read-Write Assets'
operationId: createSnippetUsingPOST
requestBody:
description: createSnippetRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CreateSnippetRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfSnippetResponse'
x-codegen-request-body-name: createSnippetRequest
/rest/asset/v1/tagType/byName.json:
get:
tags:
- Assets
summary: Marketo Get Tag By Name
description: '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'
operationId: getTagByNameUsingGET
parameters:
- name: name
in: query
description: Name of the tag
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfTagResponse'
/rest/asset/v1/smartList/{id}.json:
get:
tags:
- Assets
summary: Marketo Get Smart List by Id
description: 'Retrieves a Smart List record by its id. Required Permissions: Read-Asset or Read-Write Asset'
operationId: getSmartListByIdUsingGET
parameters:
- name: id
in: path
description: Id of the smart list to retrieve
required: true
schema:
type: integer
format: int64
- name: includeRules
in: query
description: Set true to populate smart list rules. Default false
schema:
type: boolean
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfSmartListResponseWithRules'
/rest/asset/v1/smartList/byName.json:
get:
tags:
- Assets
summary: Marketo Get Smart List by Name
description: 'Retrieves a Smart List record by its name. Required Permissions: Read-Asset or Read-Write Asset'
operationId: getSmartListByNameUsingGET
parameters:
- name: name
in: query
description: Name of smart list to retrieve
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfSmartListResponse'
/rest/asset/v1/smartList/{id}/delete.json:
post:
tags:
- Assets
summary: Marketo Delete Smart List
description: 'Deletes the designated Smart List. Required Permissions: Read-Write Asset'
operationId: deleteSmartListByIdUsingPOST
parameters:
- name: id
in: path
description: Id of the smart list to delete
required: true
schema:
type: integer
format: int64
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
/rest/asset/v1/smartLists.json:
get:
tags:
- Assets
summary: Marketo Get Smart Lists
description: 'Retrieves a list of user created Smart List records. Required Permissions: Read-Asset or Read-Write Asset'
operationId: getSmartListsUsingGET
parameters:
- name: folder
in: query
description: JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'
schema:
type: string
- name: offset
in: query
description: Integer offset for paging
schema:
type: integer
format: int32
- name: maxReturn
in: query
description: Maximum number of smart lists to return. Max 200, default 20.
schema:
type: integer
format: int32
- name: earliestUpdatedAt
in: query
description: Exclude smart lists prior to this date. Must be valid ISO-8601 string. See Datetime field type description.
schema:
type: string
- name: latestUpdatedAt
in: query
description: Exclude smart lists after this date. Must be valid ISO-8601 string. See Datetime field type description.
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfSmartListResponse'
/rest/asset/v1/smartList/{id}/clone.json:
post:
tags:
- Assets
summary: Marketo Clone Smart List
description: 'Clones the designated Smart List. Required Permissions: Read-Write Asset'
operationId: cloneSmartListUsingPOST
parameters:
- name: id
in: path
description: Id of smart list to clone
required: true
schema:
type: integer
format: int32
requestBody:
description: cloneSmartListRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CloneSmartListRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfSmartListResponse'
x-codegen-request-body-name: cloneSmartListRequest
/rest/asset/v1/staticList/{id}.json:
get:
tags:
- Assets
summary: Marketo Get Static List by Id
description: 'Retrieves a Static List record by its id. Required Permissions: Read-Asset or Read-Write Asset'
operationId: getStaticListByIdUsingGET
parameters:
- name: id
in: path
description: Id of the static list to retrieve
required: true
schema:
type: integer
format: int64
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfStaticListResponse'
post:
tags:
- Assets
summary: Marketo Update Static List Metadata
description: 'Updates the metadata of a static list asset. Required Permissions: Read-Write Assets'
operationId: updateStaticListUsingPOST
parameters:
- name: id
in: path
description: Id of static list to update
required: true
schema:
type: integer
format: int32
requestBody:
description: updateStaticListRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/UpdateStaticListRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfStaticListResponse'
x-codegen-request-body-name: updateStaticListRequest
/rest/asset/v1/staticLists.json:
get:
tags:
- Assets
summary: Marketo Get Static Lists
description: 'Retrieves a list of Static List records. Required Permissions: Read-Asset or Read-Write Asset'
operationId: getStaticListsUsingGET
parameters:
- name: folder
in: query
description: JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'
schema:
type: string
- name: offset
in: query
description: Integer offset for paging
schema:
type: integer
format: int32
- name: maxReturn
in: query
description: Maximum number of static lists to return. Max 200, default 20.
schema:
type: integer
format: int32
- name: earliestUpdatedAt
in: query
description: Exclude static lists prior to this date. Must be valid ISO-8601 string. See Datetime field type description.
schema:
type: string
- name: latestUpdatedAt
in: query
description: Exclude static lists after this date. Must be valid ISO-8601 string. See Datetime field type description.
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfStaticListResponse'
post:
tags:
- Assets
summary: Marketo Create Static List
description: 'Creates a new Static List. Required Permissions: Read-Write Assets'
operationId: createStaticListUsingPOST
requestBody:
description: createStaticListRequest
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CreateStaticListRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfStaticListResponse'
x-codegen-request-body-name: createStaticListRequest
/rest/asset/v1/staticList/byName.json:
get:
tags:
- Assets
summary: Marketo Get Static List by Name
description: 'Retrieves a Static List record by its name. Required Permissions: Read-Asset or Read-Write Asset'
operationId: getStaticListByNameUsingGET
parameters:
- name: name
in: query
description: Name of static list to retrieve
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfStaticListResponse'
/rest/asset/v1/staticList/{id}/delete.json:
post:
tags:
- Assets
summary: Marketo Delete Static List
description: 'Deletes the designated Static List. Required Permissions: Read-Write Asset'
operationId: deleteStaticListByIdUsingPOST
parameters:
- name: id
in: path
description: Id of the static list to delete
required: true
schema:
type: integer
format: int64
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfIdResponse'
/rest/asset/v1/tagTypes.json:
get:
tags:
- Assets
summary: Marketo Get Tag Types
description: 'Retrieves a list of available tag types. Required Permissions: Read-Only Assets, Read-Write Assets'
operationId: getTagTypesUsingGET
parameters:
- name: maxReturn
in: query
description: Maximum number of channels to return. Max 200, default 20
schema:
type: integer
format: int32
- name: offset
in: query
description: Integer offset for paging
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseOfTagResponseGetAll'
components:
schemas:
JsonNode:
type: object
properties:
array:
type: boolean
bigDecimal:
type: boolean
bigInteger:
type: boolean
binary:
type: boolean
boolean:
type: boolean
containerNode:
type: boolean
double:
type: boolean
float:
type: boolean
floatingPointNumber:
type: boolean
int:
type: boolean
integralNumber:
type: boolean
long:
type: boolean
missingNode:
type: boolean
nodeType:
type: string
enum:
- ARRAY
- BINARY
- BOOLEAN
- MISSING
- 'NULL'
- NUMBER
- OBJECT
- POJO
- STRING
'null':
type: boolean
number:
type: boolean
object:
type: boolean
pojo:
type: boolean
short:
type: boolean
textual:
type: boolean
valueNode:
type: boolean
LandingPageDynamicContentResponse:
type: object
properties:
content:
type: array
description: List of variations in the section
items:
$ref: '#/components/schemas/SegmentContent'
createdAt:
type: string
description: Datetime when the section was created
format: date-time
id:
type: integer
description: Id of the dnamic content section
format: int32
segmentation:
type: integer
description: Segmentation to which the section is linked
format: int32
updatedAt:
type: string
description: Datetime when the section was last updated
format: date-time
ThankYouPageRequest:
required:
- followupType
- followupValue
- operator
- subjectField
- values
type: object
properties:
default:
type: boolean
description: When true, this is the default rule, and will be applied when a user does not qualify for any of the other rules
followupType:
type: string
description: Type of followup. When set to url, will follow to the url set in followupValue. When set to lp, will follow to the Landing page with the id given in followupValue
followupValue:
type: string
description: Where to follow to on submission. Given as a URL or and Integer depending on followupType
operator:
type: string
description: Operator to evaluate aginst the subject field
subjectField:
type: string
description: Field to apply to operator to
values:
type: array
description: Comma-separated list of values to compare to with the operator
items:
type: string
UpdateStaticListRequest:
type: object
properties:
description:
type: string
description: Description of the static list
name:
type: string
description: Name of the static list
AddFormFieldVisibilityRequest:
type: object
properties:
visibilityRule:
$ref: '#/components/schemas/FormFieldVisibilityRequest'
UpdateSnippetDynamicContentRequest:
type: object
properties:
type:
type: string
description: Type of dynamic content section
enum:
- Typeofcontent.Either'HTML'or'Text'
value:
type: string
description: Value of the dynamic content section
ResponseOfSmartListResponseWithRules:
type: object
properties:
errors:
type: array
items:
$ref: '#/components/schemas/Error'
requestId:
type: string
result:
type: array
items:
$ref: '#/components/schemas/SmartListResponseWithRules'
success:
type: boolean
warnings:
type: array
items:
type: string
CloneFormRequest:
required:
- folder
- name
type: object
properties:
name:
type: string
description: Name for the cloned form
folder:
$ref: '#/components/schemas/Folder'
description:
type: string
description: Description of the cloned form
ResponseOfEmailResponse:
type: object
properties:
errors:
type: array
items:
$ref: '#/components/schemas/Error'
requestId:
type: string
result:
type: array
items:
$ref: '#/components/schemas/EmailResponse'
success:
type: boolean
warnings:
type: array
items:
type: string
SegmentationResponse:
required:
- folder
- status
type: object
properties:
createdAt:
type: string
description: Datetime the asset was created
format: date-time
description:
type: string
description: Description of the asset
folder:
$ref: '#/components/schemas/Folder'
id:
type: integer
description: Id of the asset
format: int64
name:
type: string
description: Name of the asset
status:
type: string
description: Status filter for draft or approved versions
updatedAt:
type: string
description: Datetime the asset was most recently updated
format: date-time
url:
type: string
description: Url of the asset in the Marketo UI
workspace:
type: string
description: Name of the workspace
ResponseOfEmailTemplateContentResponse:
type: object
properties:
errors:
type: array
items:
$ref: '#/components/schemas/Error'
requestId:
type: string
result:
type: array
items:
$ref: '#/components/schemas/EmailTemplateContentResponse'
success:
type: boolean
warnings:
type: array
items:
type: string
CreateLandingPageRequest:
required:
- folder
- name
- template
type: object
properties:
customHeadHTML:
type: string
description: Any custom HTML to embed in the