{ "opencollection": "1.0.0", "info": { "name": "Marketo Engage Rest Approve Emails API", "version": "1.0" }, "items": [ { "info": { "name": "Emails", "type": "folder" }, "items": [ { "info": { "name": "Marketo Get Email by Name", "type": "http" }, "http": { "method": "GET", "url": "https://localhost:8080/rest/asset/v1/email/byName.json", "params": [ { "name": "name", "value": "", "type": "query", "description": "Name of the email" }, { "name": "status", "value": "", "type": "query", "description": "Status filter for draft or approved versions" }, { "name": "folder", "value": "", "type": "query", "description": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'" } ] }, "docs": "Returns an email records based on the given name. Required Permissions: Read-Only Assets, Read-Write Assets" }, { "info": { "name": "Marketo Get Email By Id", "type": "http" }, "http": { "method": "GET", "url": "https://localhost:8080/rest/asset/v1/email/:id.json", "params": [ { "name": "id", "value": "", "type": "path", "description": "id" }, { "name": "status", "value": "", "type": "query", "description": "Status filter for draft or approved versions" } ] }, "docs": "Returns an email records by its id. Required Permissions: Read-Only Assets, Read-Write Assets" }, { "info": { "name": "Marketo Update Email Metadata", "type": "http" }, "http": { "method": "POST", "url": "https://localhost:8080/rest/asset/v1/email/:id.json", "params": [ { "name": "id", "value": "", "type": "path", "description": "id" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Updates the metadata of an email asset. Required Permissions: Read-Write Assets" }, { "info": { "name": "Marketo Approve Email Draft", "type": "http" }, "http": { "method": "POST", "url": "https://localhost:8080/rest/asset/v1/email/:id/approveDraft.json", "params": [ { "name": "id", "value": "", "type": "path", "description": "id" } ] }, "docs": "Approves the current draft of an email. Required Permissions: Approve Assets" }, { "info": { "name": "Marketo Clone Email", "type": "http" }, "http": { "method": "POST", "url": "https://localhost:8080/rest/asset/v1/email/:id/clone.json", "params": [ { "name": "id", "value": "", "type": "path", "description": "id" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Clones the target email. Required Permissions: Read-Write Assets" }, { "info": { "name": "Marketo Get Email Content", "type": "http" }, "http": { "method": "GET", "url": "https://localhost:8080/rest/asset/v1/email/:id/content.json", "params": [ { "name": "id", "value": "", "type": "path", "description": "id" }, { "name": "status", "value": "", "type": "query", "description": "Status filter for draft or approved versions" } ] }, "docs": "Returns the content of the designated email. Required Permissions: Read-Only Assets, Read-Write Assets" }, { "info": { "name": "Marketo Update Email Content", "type": "http" }, "http": { "method": "POST", "url": "https://localhost:8080/rest/asset/v1/email/:id/content.json", "params": [ { "name": "id", "value": "", "type": "path", "description": "id" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Updates the content of an email. Required Permissions: Read-Write Assets" }, { "info": { "name": "Marketo Rearrange Email Modules", "type": "http" }, "http": { "method": "POST", "url": "https://localhost:8080/rest/asset/v1/email/:id/content/rearrange.json", "params": [ { "name": "id", "value": "", "type": "path", "description": "id" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Rearranges the modules in an email. Required Permissions: Read-Write Assets" }, { "info": { "name": "Marketo Update Email Content Section", "type": "http" }, "http": { "method": "POST", "url": "https://localhost:8080/rest/asset/v1/email/:id/content/:htmlId.json", "params": [ { "name": "id", "value": "", "type": "path", "description": "id" }, { "name": "htmlId", "value": "", "type": "path", "description": "htmlId" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Updates the content in the given section. Required Permissions: Read-Write Assets" }, { "info": { "name": "Marketo Add Email Module", "type": "http" }, "http": { "method": "POST", "url": "https://localhost:8080/rest/asset/v1/email/:id/content/:moduleId/add.json", "params": [ { "name": "id", "value": "", "type": "path", "description": "id" }, { "name": "moduleId", "value": "", "type": "path", "description": "moduleId" }, { "name": "name", "value": "", "type": "query", "description": "Name of the module" }, { "name": "index", "value": "", "type": "query", "description": "Index of the module. Determines the order of the module in the email." } ] }, "docs": "Adds a new module to an email, with the given id. Required Permissions: Read-Write Assets" }, { "info": { "name": "Marketo Delete Module", "type": "http" }, "http": { "method": "POST", "url": "https://localhost:8080/rest/asset/v1/email/:id/content/:moduleId/delete.json", "params": [ { "name": "id", "value": "", "type": "path", "description": "id" }, { "name": "moduleId", "value": "", "type": "path", "description": "moduleId" } ] }, "docs": "Deletes the given module from the email. Required Permissions: Read-Write Assets" }, { "info": { "name": "Marketo Duplicate Email Module", "type": "http" }, "http": { "method": "POST", "url": "https://localhost:8080/rest/asset/v1/email/:id/content/:moduleId/duplicate.json", "params": [ { "name": "id", "value": "", "type": "path", "description": "id" }, { "name": "moduleId", "value": "", "type": "path", "description": "moduleId" }, { "name": "name", "value": "", "type": "query", "description": "Name of the new module" } ] }, "docs": "Creates a copy of the designated module in an email. Required Permissions: Read-Write Assets" }, { "info": { "name": "Marketo Rename Email Module", "type": "http" }, "http": { "method": "POST", "url": "https://localhost:8080/rest/asset/v1/email/:id/content/:moduleId/rename.json", "params": [ { "name": "id", "value": "", "type": "path", "description": "id" }, { "name": "moduleId", "value": "", "type": "path", "description": "moduleId" }, { "name": "name", "value": "", "type": "query", "description": "New module name" } ] }, "docs": "Renames a module. Required Permissions: Read-Write Assets" }, { "info": { "name": "Marketo Delete Email", "type": "http" }, "http": { "method": "POST", "url": "https://localhost:8080/rest/asset/v1/email/:id/delete.json", "params": [ { "name": "id", "value": "", "type": "path", "description": "id" } ] }, "docs": "Deletes the target email. Required Permissions: Read-Write Assets" }, { "info": { "name": "Marketo Discard Email Draft", "type": "http" }, "http": { "method": "POST", "url": "https://localhost:8080/rest/asset/v1/email/:id/discardDraft.json", "params": [ { "name": "id", "value": "", "type": "path", "description": "id" } ] }, "docs": "Discards the current draft of an email. Required Permissions: Read-Write Assets" }, { "info": { "name": "Marketo Get Email Dynamic Content", "type": "http" }, "http": { "method": "GET", "url": "https://localhost:8080/rest/asset/v1/email/:id/dynamicContent/:contentId.json", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of email" }, { "name": "contentId", "value": "", "type": "path", "description": "Id of email dynamic content section" }, { "name": "status", "value": "", "type": "query", "description": "Status filter for draft or approved versions" } ] }, "docs": "Retrieves the dyanmic content record for the given section. Required Permissions: Read-Only Assets, Read-Write Assets" }, { "info": { "name": "Marketo Update Email Dynamic Content Section", "type": "http" }, "http": { "method": "POST", "url": "https://localhost:8080/rest/asset/v1/email/:id/dynamicContent/:contentId.json", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of email" }, { "name": "contentId", "value": "", "type": "path", "description": "Id of email dynamic content section" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Updates dynamic content in the given section. Required Permissions: Read-Write Assets" }, { "info": { "name": "Marketo Send Sample Email", "type": "http" }, "http": { "method": "POST", "url": "https://localhost:8080/rest/asset/v1/email/:id/sendSample.json", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the email" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "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" }, { "info": { "name": "Marketo Unapprove Email", "type": "http" }, "http": { "method": "POST", "url": "https://localhost:8080/rest/asset/v1/email/:id/unapprove.json", "params": [ { "name": "id", "value": "", "type": "path", "description": "id" } ] }, "docs": "Unapproves the email and reverts it to a draft-only state. Required Permissions: Approve Assets" }, { "info": { "name": "Marketo Update Email Variable", "type": "http" }, "http": { "method": "POST", "url": "https://localhost:8080/rest/asset/v1/email/:id/variable/:name.json", "params": [ { "name": "id", "value": "", "type": "path", "description": "id" }, { "name": "name", "value": "", "type": "path", "description": "name" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Updates the value of a given variable in an email. Required Permissions: Read-Write Assets" }, { "info": { "name": "Marketo Get Email Variables", "type": "http" }, "http": { "method": "GET", "url": "https://localhost:8080/rest/asset/v1/email/:id/variables.json", "params": [ { "name": "id", "value": "", "type": "path", "description": "id" } ] }, "docs": "Returns a list of the available variables in an email. Required Permissions: Read-Only Assets, Read-Write Assets" }, { "info": { "name": "Marketo Get Email CC Fields", "type": "http" }, "http": { "method": "GET", "url": "https://localhost:8080/rest/asset/v1/email/ccFields.json" }, "docs": "Returns the set of fields enabled for Email CC in the target instance. Required Permissions: Read-Only Assets, Read-Write Assets" }, { "info": { "name": "Marketo Get Emails", "type": "http" }, "http": { "method": "GET", "url": "https://localhost:8080/rest/asset/v1/emails.json", "params": [ { "name": "status", "value": "", "type": "query", "description": "Status filter for draft or approved versions" }, { "name": "folder", "value": "", "type": "query", "description": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'" }, { "name": "offset", "value": "", "type": "query", "description": "Integer offset for paging" }, { "name": "maxReturn", "value": "", "type": "query", "description": "Maximum number of emails to return. Max 200, default 20" }, { "name": "earliestUpdatedAt", "value": "", "type": "query", "description": "Exclude emails prior to this date. Must be valid ISO-8601 string. See Datetime field type description." }, { "name": "latestUpdatedAt", "value": "", "type": "query", "description": "Exclude emails after this date. Must be valid ISO-8601 string. See Datetime field type description." } ] }, "docs": "Returns a list of emails matching the given filter parameters. Required Permissions: Read-Only Assets, Read-Write Assets" }, { "info": { "name": "Marketo Create Email", "type": "http" }, "http": { "method": "POST", "url": "https://localhost:8080/rest/asset/v1/emails.json", "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Creates a new email asset. Required Permissions: Read-Write Assets" }, { "info": { "name": "Marketo Get Email Full Content", "type": "http" }, "http": { "method": "GET", "url": "https://localhost:8080/rest/asset/v1/email/:id/fullContent.json", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the email" }, { "name": "status", "value": "", "type": "query", "description": "Status filter for draft or approved versions. Defaults to approved if asset is approved, draft if not." }, { "name": "leadId", "value": "", "type": "query", "description": "The lead id to impersonate. Email is rendered as though it was received by this lead." }, { "name": "type", "value": "", "type": "query", "description": "Email content type to return. Default is HTML." } ] }, "docs": "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." }, { "info": { "name": "Marketo Update Email Full Content", "type": "http" }, "http": { "method": "POST", "url": "https://localhost:8080/rest/asset/v1/email/:id/fullContent.json", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the email" } ], "body": { "type": "multipart-form", "data": [] } }, "docs": "Replaces the HTML of an Email that has had its relationship broken from its template. Required Permissions: Read-Write Assets" } ] } ], "bundled": true }