{ "info": { "_postman_id": "34577661-b5e8-551e-9336-ba88e94204b9", "name": "Marketo Engage API Reference (Unofficial)", "description": "An unofficial Postman collection for the Adobe Marketo Engage REST, Identity, User Management and Data Ingestion APIs, with one request for every operation in Adobe's published specifications.\n\n> THIS COLLECTION IS NOT AUTHORIZED, ENDORSED OR SPONSORED BY ADOBE, PUBLISHER OF ADOBE MARKETO ENGAGE. Adobe, Marketo and Marketo Engage are either registered trademarks or trademarks of Adobe in the United States and/or other countries.\n\n## Set up\n\n1. Import the **Marketo Engage (template)** environment, select it, and set `marketoBaseUrl` (your REST API endpoint origin, such as `https://.mktorest.com`, without `/rest` or `/identity`), `clientId` and `clientSecret`. For the Data Ingestion API, also set `munchkinId`.\n2. Send **Identity API › Identity › GET · Identity** (or the POST version). Its post-response script saves the token to `accessToken` and its expiry time, in epoch milliseconds, to `accessTokenExpiresAt`.\n3. Open any other request, fill in its parameters and body, and send it. Every request uses the token; when it expires, send the Identity request again.\n\n## How this collection behaves\n\n- Requests run only when you send them. There are no pre-request scripts, no automatic token refresh, no retries, no request chaining and no automatic pagination. The only script is on the Identity requests, and it only saves the token and its expiry time.\n- Required parameters are enabled and empty unless the source specification gives a default; optional parameters are disabled until you enable them.\n- Postman sends `+` in query values as-is, and servers read it as a space. Enter a literal plus sign as `%2B`, for example in a date-time with a time zone offset: `2026-10-01T00:00:00%2B10:00`.\n- JSON bodies start with required properties only, set to `null` where you must supply a value. Request descriptions list every documented property.\n- Paging is manual: request descriptions explain each operation's paging parameters, and you send each page yourself.\n- The collection includes operations that create, change, delete, send or trigger things. Their descriptions say so. **Don't run the whole collection or a folder with the Collection Runner:** it sends every selected request, including destructive ones. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\n## Source and licence\n\nGenerated from Adobe's Marketo Engage API specifications ([AdobeDocs/marketo-apis](https://github.com/AdobeDocs/marketo-apis)), © Adobe, licensed under the Apache License 2.0. Use of the Marketo APIs is subject to Adobe's [API License Agreement](https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/api-license).\n\nFull reference: [API Reference for Marketo Engage](https://mkto-ref.harrisonjennings.au/). Source, licence and notices: [harrison-jennings/api-reference-for-marketo-engage](https://github.com/harrison-jennings/api-reference-for-marketo-engage).", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "id": "37fe31d9-7fd1-54fb-96df-81279d9fc371", "name": "Identity API", "description": "OAuth 2.0 client-credentials token issuance. Send a request in this folder to get an access token for every other API.\n\n- **Base URL:** `{{marketoBaseUrl}}`\n- **Authentication:** None. This request sends `client_id`, `client_secret` and `grant_type` as query parameters, from the `{{clientId}}` and `{{clientSecret}}` variables.\n- **Reference:** [Identity API on the documentation site](https://mkto-ref.harrisonjennings.au/reference/identity/)\n\nRequests run only when you send them, or when you select them for a Postman run.", "item": [ { "id": "87d3a3b4-177b-5c12-93b8-88045a26cc2d", "name": "Identity", "description": "Identity operations in the Identity API. Reference: [Identity](https://mkto-ref.harrisonjennings.au/reference/identity/identity/).", "item": [ { "id": "24e181a5-f79c-5d8c-8247-6b9ffc41e244", "name": "GET · Identity", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "// Saves access_token and its expiry to the selected environment after you send this request.", "// It sends no requests and changes no other variables. Send this request again when the token expires.", "(function saveAccessToken() {", " var notSaved = \"Access token not saved: \";", " if (pm.response.code < 200 || pm.response.code > 299) {", " console.warn(notSaved + \"the response status was \" + pm.response.code + \".\");", " return;", " }", " var body;", " try {", " body = pm.response.json();", " } catch (error) {", " console.warn(notSaved + \"the response is not JSON.\");", " return;", " }", " if (!body || typeof body !== \"object\" || body.success === false) {", " console.warn(notSaved + \"the response reports an error.\");", " return;", " }", " if (typeof body.access_token !== \"string\" || body.access_token === \"\") {", " console.warn(notSaved + \"the response has no access_token.\");", " return;", " }", " if (typeof body.expires_in !== \"number\" || !isFinite(body.expires_in) || body.expires_in <= 0) {", " console.warn(notSaved + \"the response has no valid expires_in.\");", " return;", " }", " if (!pm.environment || !pm.environment.name) {", " console.warn(notSaved + \"select an environment, then send this request again.\");", " return;", " }", " var expiresAt = Date.now() + body.expires_in * 1000;", " try {", " pm.environment.set(\"accessToken\", body.access_token);", " pm.environment.set(\"accessTokenExpiresAt\", String(expiresAt));", " } catch (error) {", " console.warn(notSaved + \"the environment could not be updated.\");", " return;", " }", " console.log(\"Access token saved to the \" + pm.environment.name + \" environment. It expires at \" + new Date(expiresAt).toISOString() + \".\");", "})();" ] } } ], "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/identity/oauth/token?client_id={{clientId}}&client_secret={{clientSecret}}&grant_type=client_credentials", "host": [ "{{marketoBaseUrl}}" ], "path": [ "identity", "oauth", "token" ], "query": [ { "key": "client_id", "value": "{{clientId}}", "description": "Client ID from Admin > Integration > Launchpoint menu. Required, string." }, { "key": "client_secret", "value": "{{clientSecret}}", "description": "Client Secret from Admin > Integration > Launchpoint menu. Required, string." }, { "key": "grant_type", "value": "client_credentials", "description": "Grant type. Required, string. Allowed values: `client_credentials`." } ] }, "auth": { "type": "noauth" }, "description": "Retrieve an access token from Marketo Engage. Calls to this endpoint are not counted towards API call limit.\n\n- **Endpoint:** `GET /identity/oauth/token`\n- **Operation ID:** `identityUsingGET`\n- **API:** Identity API · Identity\n- **Authentication:** None. This request sends `client_id`, `client_secret` and `grant_type` as query parameters, from the `{{clientId}}` and `{{clientSecret}}` variables.\n- **Reference:** [Identity on the documentation site](https://mkto-ref.harrisonjennings.au/reference/identity/identity/identity/)\n\n### Parameters\n\n- `client_id` · query param · string · required\n- `client_secret` · query param · string · required\n- `grant_type` · query param · string · required · Allowed values: `client_credentials`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdentity](https://mkto-ref.harrisonjennings.au/reference/identity/models/responseofidentity/)\n\nDeclared response media type: `application/json`.\n\n### Notes\n\n- As documented, `client_id` and `client_secret` are sent in the URL query string. URLs can appear in Postman's history and console, and in proxy or server logs: keep these values in your environment's local (current) values or Postman Vault, and don't share or sync them.\n- After you send this request, its post-response script saves `access_token` to `{{accessToken}}` and the expiry time (epoch milliseconds) to `{{accessTokenExpiresAt}}` in the selected environment. Nothing renews the token automatically: send this request again when it expires." } }, { "id": "8210d1dc-09aa-50cc-8982-643b3a5c57ed", "name": "POST · Identity", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "// Saves access_token and its expiry to the selected environment after you send this request.", "// It sends no requests and changes no other variables. Send this request again when the token expires.", "(function saveAccessToken() {", " var notSaved = \"Access token not saved: \";", " if (pm.response.code < 200 || pm.response.code > 299) {", " console.warn(notSaved + \"the response status was \" + pm.response.code + \".\");", " return;", " }", " var body;", " try {", " body = pm.response.json();", " } catch (error) {", " console.warn(notSaved + \"the response is not JSON.\");", " return;", " }", " if (!body || typeof body !== \"object\" || body.success === false) {", " console.warn(notSaved + \"the response reports an error.\");", " return;", " }", " if (typeof body.access_token !== \"string\" || body.access_token === \"\") {", " console.warn(notSaved + \"the response has no access_token.\");", " return;", " }", " if (typeof body.expires_in !== \"number\" || !isFinite(body.expires_in) || body.expires_in <= 0) {", " console.warn(notSaved + \"the response has no valid expires_in.\");", " return;", " }", " if (!pm.environment || !pm.environment.name) {", " console.warn(notSaved + \"select an environment, then send this request again.\");", " return;", " }", " var expiresAt = Date.now() + body.expires_in * 1000;", " try {", " pm.environment.set(\"accessToken\", body.access_token);", " pm.environment.set(\"accessTokenExpiresAt\", String(expiresAt));", " } catch (error) {", " console.warn(notSaved + \"the environment could not be updated.\");", " return;", " }", " console.log(\"Access token saved to the \" + pm.environment.name + \" environment. It expires at \" + new Date(expiresAt).toISOString() + \".\");", "})();" ] } } ], "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/identity/oauth/token?client_id={{clientId}}&client_secret={{clientSecret}}&grant_type=client_credentials", "host": [ "{{marketoBaseUrl}}" ], "path": [ "identity", "oauth", "token" ], "query": [ { "key": "client_id", "value": "{{clientId}}", "description": "Client ID from Admin > Integration > Launchpoint menu. Required, string." }, { "key": "client_secret", "value": "{{clientSecret}}", "description": "Client Secret from Admin > Integration > Launchpoint menu. Required, string." }, { "key": "grant_type", "value": "client_credentials", "description": "Grant type. Required, string. Allowed values: `client_credentials`." } ] }, "auth": { "type": "noauth" }, "description": "Retrieve an access token from Marketo. Calls to this endpoint are not counted towards API call limit.\n\n- **Endpoint:** `POST /identity/oauth/token`\n- **Operation ID:** `identityUsingPOST`\n- **API:** Identity API · Identity\n- **Authentication:** None. This request sends `client_id`, `client_secret` and `grant_type` as query parameters, from the `{{clientId}}` and `{{clientSecret}}` variables.\n- **Reference:** [Identity on the documentation site](https://mkto-ref.harrisonjennings.au/reference/identity/identity/identity-2/)\n\n### Parameters\n\n- `client_id` · query param · string · required\n- `client_secret` · query param · string · required\n- `grant_type` · query param · string · required · Allowed values: `client_credentials`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdentity](https://mkto-ref.harrisonjennings.au/reference/identity/models/responseofidentity/)\n\nDeclared response media type: `application/json`.\n\n### Notes\n\n- As documented, `client_id` and `client_secret` are sent in the URL query string. URLs can appear in Postman's history and console, and in proxy or server logs: keep these values in your environment's local (current) values or Postman Vault, and don't share or sync them.\n- After you send this request, its post-response script saves `access_token` to `{{accessToken}}` and the expiry time (epoch milliseconds) to `{{accessTokenExpiresAt}}` in the selected environment. Nothing renews the token automatically: send this request again when it expires." } } ] } ] }, { "id": "fc76bdf6-0a04-5162-9582-6d72383f837a", "name": "Asset API", "description": "Emails, templates, forms, landing pages, programs, smart campaigns, smart lists, files, folders, snippets and tokens.\n\n- **Base URL:** `{{marketoBaseUrl}}`\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Asset API on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/)\n\nRequests run only when you send them, or when you select them for a Postman run.", "item": [ { "id": "c603aa3d-e9e6-513f-b798-42d243f7b8e3", "name": "Channels", "description": "Channels operations in the Asset API. Reference: [Channels](https://mkto-ref.harrisonjennings.au/reference/asset/channels/).", "item": [ { "id": "bba460ad-a4b2-53a9-b762-6b2f7731418a", "name": "GET · Get Channel by Name", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/channel/byName.json?Name=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "channel", "byName.json" ], "query": [ { "key": "Name", "value": "", "description": "Name of channel to retrieve. Required, string." } ] }, "description": "Retrieves channels based on the provided name. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/channel/byName.json`\n- **Operation ID:** `getChannelByNameUsingGET`\n- **API:** Asset API · Channels\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Channel by Name on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/channels/get-channel-by-name/)\n\n### Parameters\n\n- `Name` · query param · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfChannelResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofchannelresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "3b06e324-1f55-51ac-860b-c836cc500730", "name": "GET · Get Channels", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/channels.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "channels.json" ], "query": [ { "key": "maxReturn", "value": "", "description": "Maximum number of records to return. Max 200, default 20. Optional, integer (int32).", "disabled": true }, { "key": "offset", "value": "", "description": "Integer offset for paging. Optional, integer (int32).", "disabled": true } ] }, "description": "Retrieves all channels. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/channels.json`\n- **Operation ID:** `getAllChannelsUsingGET`\n- **API:** Asset API · Channels\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Channels on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/channels/get-channels/)\n\n### Parameters\n\n- `maxReturn` · query param · integer (int32) · optional\n- `offset` · query param · integer (int32) · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfChannelResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofchannelresponse/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n- `offset`: Integer offset for paging.\n- `maxReturn`: Maximum number of records to return. Max 200, default 20.\n\nAdobe's [Asset API documentation](https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/assets/assets) describes `offset` as the position at which to begin returning results, not a page number. To get the next page, add the `maxReturn` value you used to `offset` and send the request again.\n\nContinue until a response returns no more records. The source specification does not say that a page with fewer than `maxReturn` records is the last one.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } } ] }, { "id": "b8a93b4b-d182-506c-b0b5-ac76c4dff975", "name": "Email Templates", "description": "Email Templates operations in the Asset API. Reference: [Email Templates](https://mkto-ref.harrisonjennings.au/reference/asset/email-templates/).", "item": [ { "id": "1f488ad2-d08f-5dbf-99d6-556ae4d798db", "name": "GET · Get Email Template by Name", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/emailTemplate/byName.json?name=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "emailTemplate", "byName.json" ], "query": [ { "key": "name", "value": "", "description": "name. Required, string." }, { "key": "status", "value": "", "description": "Status filter for draft or approved versions. Optional, string. Allowed values: `approved`, `draft`.", "disabled": true } ] }, "description": "Retrieves and email template record by the given name. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/emailTemplate/byName.json`\n- **Operation ID:** `getTemplateByNameUsingGET`\n- **API:** Asset API · Email Templates\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Email Template by Name on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/email-templates/get-email-template-by-name/)\n\n### Parameters\n\n- `name` · query param · string · required\n- `status` · query param · string · optional · Allowed values: `approved`, `draft`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfEmailTemplateResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofemailtemplateresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "aa6681b1-7cf2-5187-a3cf-9ee69e15dbcc", "name": "GET · Get Email Template by Id", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/emailTemplate/:id.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "emailTemplate", ":id.json" ], "query": [ { "key": "status", "value": "", "description": "Status filter for draft or approved versions. Optional, string. Allowed values: `approved`, `draft`.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "Returns an email template record by its id. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/emailTemplate/{id}.json`\n- **Operation ID:** `getTemplateByIdUsingGET`\n- **API:** Asset API · Email Templates\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Email Template by Id on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/email-templates/get-email-template-by-id/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `status` · query param · string · optional · Allowed values: `approved`, `draft`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfEmailTemplateResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofemailtemplateresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "34d17880-5891-5bc9-b96c-c411226c4b8c", "name": "POST · Update Email Template Metadata", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "description", "value": "", "type": "text", "description": "Description of the asset. Optional, string.", "disabled": true }, { "key": "name", "value": "", "type": "text", "description": "Name of the Email Template. Optional, string.", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/emailTemplate/:id.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "emailTemplate", ":id.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdates the metadata for the designated email template. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/emailTemplate/{id}.json`\n- **Operation ID:** `updateEmailTemplateUsingPOST`\n- **API:** Asset API · Email Templates\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Email Template Metadata on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/email-templates/update-email-template-metadata/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [UpdateEmailTemplateMetaDataRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/updateemailtemplatemetadatarequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n### Responses\n\n- `200` — OK · [ResponseOfEmailTemplateResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofemailtemplateresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "aa56fa3e-267d-5896-abbb-cc631d04668e", "name": "POST · Approve Email Template Draft", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/emailTemplate/:id/approveDraft.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "emailTemplate", ":id", "approveDraft.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request approves an asset in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nApproves the current draft of the email template. Required Permissions: Approve Assets\n\n- **Endpoint:** `POST /rest/asset/v1/emailTemplate/{id}/approveDraft.json`\n- **Operation ID:** `approveDraftUsingPOST_1`\n- **API:** Asset API · Email Templates\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Approve Email Template Draft on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/email-templates/approve-email-template-draft/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfEmailTemplateResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofemailtemplateresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "9e0388cf-ec08-5461-be45-73d153120862", "name": "POST · Clone Email Template", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "description", "value": "", "type": "text", "description": "Description of the asset. Optional, string.", "disabled": true }, { "key": "folder", "value": "", "type": "text", "description": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'. Required, Folder. Send the value as JSON text; its properties are listed in the request description." }, { "key": "name", "value": "", "type": "text", "description": "Name of the Email Template. Required, string." } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/emailTemplate/:id/clone.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "emailTemplate", ":id", "clone.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request creates a copy of an asset in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nClones the designated email template. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/emailTemplate/{id}/clone.json`\n- **Operation ID:** `cloneTemplateUsingPOST`\n- **API:** Asset API · Email Templates\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Clone Email Template on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/email-templates/clone-email-template/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [CloneEmailTemplateRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/cloneemailtemplaterequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n**Properties of JSON-valued fields**\n\n- `folder.id` · integer (int32) · required — Id of the folder.\n- `folder.type` · string · required — Type of folder. Allowed values: `Folder`, `Program`.\n\n### Responses\n\n- `200` — OK · [ResponseOfEmailTemplateResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofemailtemplateresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "69f2994b-7811-5f2a-b619-eada7cc38e8e", "name": "GET · Get Email Template Content by Id", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/emailTemplate/:id/content", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "emailTemplate", ":id", "content" ], "query": [ { "key": "status", "value": "", "description": "Status filter for draft or approved versions. Optional, string. Allowed values: `approved`, `draft`.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "Returns the content for a given email template. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/emailTemplate/{id}/content`\n- **Operation ID:** `getTemplateContentByIdUsingGET`\n- **API:** Asset API · Email Templates\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Email Template Content by Id on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/email-templates/get-email-template-content-by-id/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `status` · query param · string · optional · Allowed values: `approved`, `draft`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfEmailTemplateContentResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofemailtemplatecontentresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "ec11aceb-d446-51ff-83a4-787e2893fea5", "name": "POST · Update Email Template Content", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "content", "type": "file", "description": "Content for the email template. Multipart file. Optional, file. Select a file in the Body tab before sending.", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/emailTemplate/:id/content.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "emailTemplate", ":id", "content.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdates the content of the given email template. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/emailTemplate/{id}/content.json`\n- **Operation ID:** `updateEmailTemplateContentUsingPOST`\n- **API:** Asset API · Email Templates\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Email Template Content on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/email-templates/update-email-template-content/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`multipart/form-data` · optional · model [UpdateEmailTemplateContentRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/updateemailtemplatecontentrequest/)\n\nEach form field is a row in the **Body** tab (form-data), with its description. Required fields are enabled; optional fields are disabled until you enable them. File fields have no file selected.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "4e01be6d-04c9-5559-ab01-1ef5f3b5347a", "name": "POST · Delete Email Template", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/emailTemplate/:id/delete.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "emailTemplate", ":id", "delete.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDeletes the designated email template. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/emailTemplate/{id}/delete.json`\n- **Operation ID:** `deleteTemplateUsingPOST`\n- **API:** Asset API · Email Templates\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete Email Template on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/email-templates/delete-email-template/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "ece991b5-7691-55e5-b128-8870a042e991", "name": "POST · Discard Email Template Draft", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/emailTemplate/:id/discardDraft.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "emailTemplate", ":id", "discardDraft.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request discards a draft in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDiscards the current draft of the email template. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/emailTemplate/{id}/discardDraft.json`\n- **Operation ID:** `discardDraftUsingPOST_1`\n- **API:** Asset API · Email Templates\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Discard Email Template Draft on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/email-templates/discard-email-template-draft/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "3c5ee641-f5d9-5146-96b8-62c609bf1d39", "name": "POST · Unapprove Email Template Draft", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/emailTemplate/:id/unapprove.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "emailTemplate", ":id", "unapprove.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request unapproves an asset in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUnapproves the current approved version of the Email Template. Required Permissions: Approve Assets\n\n- **Endpoint:** `POST /rest/asset/v1/emailTemplate/{id}/unapprove.json`\n- **Operation ID:** `unapproveDraftUsingPOST_1`\n- **API:** Asset API · Email Templates\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Unapprove Email Template Draft on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/email-templates/unapprove-email-template-draft/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfEmailTemplateResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofemailtemplateresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "1186828a-13af-586d-a143-9a92428ff855", "name": "GET · Get Email Templates", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/emailTemplates.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "emailTemplates.json" ], "query": [ { "key": "offset", "value": "", "description": "Integer offset for paging. Optional, integer (int32).", "disabled": true }, { "key": "maxReturn", "value": "", "description": "Maximum number of records to return. Max 200, default 20. Optional, integer (int32).", "disabled": true }, { "key": "status", "value": "", "description": "Status filter for draft or approved versions. Optional, string. Allowed values: `approved`, `draft`.", "disabled": true } ] }, "description": "Returns a list of email template records accessible in the target instance. Required Permissions: Read-Only Assets, Read-Write Assets.\n\nNote: Email templates created with the new email designer may appear in this API's response, but some of the fields may be null or incomplete. For complete and reliable details of these assets, use the Email Templates (New) APIs; refer to the [List Email Templates](https://developer.adobe.com/marketo-apis/api/asset#operation/filterContentUsingGET_emailtemplate) endpoint.\n\n- **Endpoint:** `GET /rest/asset/v1/emailTemplates.json`\n- **Operation ID:** `getEmailTemplatesUsingGET`\n- **API:** Asset API · Email Templates\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Email Templates on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/email-templates/get-email-templates/)\n\n### Parameters\n\n- `offset` · query param · integer (int32) · optional\n- `maxReturn` · query param · integer (int32) · optional\n- `status` · query param · string · optional · Allowed values: `approved`, `draft`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfEmailTemplateResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofemailtemplateresponse/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n- `offset`: Integer offset for paging.\n- `maxReturn`: Maximum number of records to return. Max 200, default 20.\n\nAdobe's [Asset API documentation](https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/assets/assets) describes `offset` as the position at which to begin returning results, not a page number. To get the next page, add the `maxReturn` value you used to `offset` and send the request again.\n\nContinue until a response returns no more records. The source specification does not say that a page with fewer than `maxReturn` records is the last one.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "abf411b2-82de-58f2-88bd-e021a6feebdf", "name": "POST · Create Email Template", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "", "type": "text", "description": "Name of the Email Template. Must be unique under the parent folder. Required, string." }, { "key": "folder", "value": "", "type": "text", "description": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'. Required, Folder. Send the value as JSON text; its properties are listed in the request description." }, { "key": "description", "value": "", "type": "text", "description": "Description of the email template. Optional, string.", "disabled": true }, { "key": "content", "type": "file", "description": "HTML content for template. Multipart file. Required, file. Select a file in the Body tab before sending." } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/emailTemplates.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "emailTemplates.json" ] }, "description": "> **Changes data.** Sending this request creates data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nCreates a new email template. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/emailTemplates.json`\n- **Operation ID:** `createEmailTemplateUsingPOST`\n- **API:** Asset API · Email Templates\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Create Email Template on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/email-templates/create-email-template/)\n\n### Request body\n\n`multipart/form-data` · required · model [CreateEmailTemplateRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/createemailtemplaterequest/)\n\nEach form field is a row in the **Body** tab (form-data), with its description. Required fields are enabled; optional fields are disabled until you enable them. File fields have no file selected.\n\n**Properties of JSON-valued fields**\n\n- `folder.id` · integer (int32) · required — Id of the folder.\n- `folder.type` · string · required — Type of folder. Allowed values: `Folder`, `Program`.\n\n### Responses\n\n- `200` — OK · [ResponseOfEmailTemplateResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofemailtemplateresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "f371caea-95ef-590f-9933-4a92d257f62b", "name": "GET · Get Email Template Used By", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/emailTemplates/:id/usedBy.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "emailTemplates", ":id", "usedBy.json" ], "query": [ { "key": "offset", "value": "", "description": "Integer offset for paging. Optional, integer (int32).", "disabled": true }, { "key": "maxReturn", "value": "", "description": "Maximum number of records to return. Max 200, default 20. Optional, integer (int32).", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "Id of the email template. Required, integer (int32)." } ] }, "description": "Returns a list of email records which depend on a given email template. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/emailTemplates/{id}/usedBy.json`\n- **Operation ID:** `getEmailTemplateUsedByUsingGET`\n- **API:** Asset API · Email Templates\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Email Template Used By on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/email-templates/get-email-template-used-by/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `offset` · query param · integer (int32) · optional\n- `maxReturn` · query param · integer (int32) · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfEmailTemplateUsedByResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofemailtemplateusedbyresponse/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n- `offset`: Integer offset for paging.\n- `maxReturn`: Maximum number of records to return. Max 200, default 20.\n\nAdobe's [Asset API documentation](https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/assets/assets) describes `offset` as the position at which to begin returning results, not a page number. To get the next page, add the `maxReturn` value you used to `offset` and send the request again.\n\nContinue until a response returns no more records. The source specification does not say that a page with fewer than `maxReturn` records is the last one.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } } ] }, { "id": "9f4ef36f-30ac-5879-bc03-4827189aa0f1", "name": "Email Templates (New)", "description": "Email Templates (New) operations in the Asset API. Reference: [Email Templates (New)](https://mkto-ref.harrisonjennings.au/reference/asset/email-templates-new/).", "item": [ { "id": "944feeef-e9ec-56d0-be96-857c91f448c5", "name": "POST · Create Email Template", "request": { "method": "POST", "header": [ { "key": "x-app-type", "value": "marketo", "type": "text", "description": "Application type header. Required, string. Allowed values: `marketo`." } ], "body": { "mode": "raw", "raw": "{\n \"name\": null,\n \"appData\": {}\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v2/emailtemplate", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v2", "emailtemplate" ] }, "description": "> **Changes data.** Sending this request creates data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nCreates a new email template. Required Permissions: Read-Write Assets, Access Design Studio, Edit Email Template.\n\n- **Endpoint:** `POST /rest/asset/v2/emailtemplate`\n- **Operation ID:** `createContentUsingPOST_emailtemplate`\n- **API:** Asset API · Email Templates (New)\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Create Email Template on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/email-templates-new/create-email-template/)\n\n### Parameters\n\n- `access_token` · not sent; see notes · string · required — Token for Authorization.\n- `x-app-type` · header · string · required · Allowed values: `marketo`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [CreateEmailTemplateV2Request](https://mkto-ref.harrisonjennings.au/reference/asset/models/createemailtemplatev2request/)\n\nThe body starts with the required properties only, set to `null`. Replace each `null` with a value, and add any optional properties you need.\n\n**Properties**\n\n- `name` · string · required — Not documented in the source specification.\n- `description` · string · optional — Not documented in the source specification.\n- `appData` · AppDataDTO · required — Not documented in the source specification.\n- `appData.editorType` · string · optional — Not documented in the source specification.\n- `appData.folderId` · string · optional — Not documented in the source specification.\n- `appData.workspaceId` · string · optional — Not documented in the source specification.\n- `data` · DataDTO · optional — Not documented in the source specification.\n- `data.html` · HtmlDataDTO · optional — Not documented in the source specification.\n- `data.html.body` · string · optional — Not documented in the source specification.\n- `data.text` · TextDataDTO · optional — Not documented in the source specification.\n- `data.text.body` · string · optional — Not documented in the source specification.\n- `data.text.syncFromHtml` · boolean · optional — Not documented in the source specification.\n- `editorContext` · EditorContextDto · optional — Not documented in the source specification.\n- `editorContext.dynamicContent` · object · optional — Not documented in the source specification.\n\n### Responses\n\n- `200` — OK · [EmailTemplateNewResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/emailtemplatenewresponse/)\n- `default` — Error · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/errorresponse/)\n\nDeclared response media type: `application/json`.\n\n### Notes\n\n- The source specification also lists an `access_token` query parameter. This collection sends the token in the `Authorization` header instead, so it is never added to URLs." } }, { "id": "2055687d-315e-59dc-a5b9-f3f9a98b117f", "name": "POST · Clone Email Template", "request": { "method": "POST", "header": [ { "key": "x-app-type", "value": "marketo", "type": "text", "description": "Application type header. Required, string. Allowed values: `marketo`." } ], "body": { "mode": "raw", "raw": "{\n \"assetId\": null,\n \"newAsset\": {\n \"name\": null\n }\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v2/emailtemplate/clone", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v2", "emailtemplate", "clone" ] }, "description": "> **Changes data.** Sending this request creates a copy of an asset in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nClones an existing email template. Required Permissions: Read-Write Assets, Access Design Studio, Edit Email Template.\n\n- **Endpoint:** `POST /rest/asset/v2/emailtemplate/clone`\n- **Operation ID:** `cloneContentUsingPOST_emailtemplate`\n- **API:** Asset API · Email Templates (New)\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Clone Email Template on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/email-templates-new/clone-email-template/)\n\n### Parameters\n\n- `access_token` · not sent; see notes · string · required — Token for Authorization.\n- `x-app-type` · header · string · required · Allowed values: `marketo`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [CloneAssetRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/cloneassetrequest/)\n\nThe body starts with the required properties only, set to `null`. Replace each `null` with a value, and add any optional properties you need.\n\n**Properties**\n\n- `assetId` · string · required — Not documented in the source specification.\n- `newAsset` · CloneNewAsset · required — Not documented in the source specification.\n- `newAsset.name` · string · required — Not documented in the source specification.\n- `newAsset.description` · string · optional — Not documented in the source specification.\n\n### Responses\n\n- `200` — OK · [EmailTemplateNewResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/emailtemplatenewresponse/)\n- `default` — Error · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/errorresponse/)\n\nDeclared response media type: `application/json`.\n\n### Notes\n\n- The source specification also lists an `access_token` query parameter. This collection sends the token in the `Authorization` header instead, so it is never added to URLs." } }, { "id": "daa57f3e-779e-5d20-adb0-d2fe9e61fcd4", "name": "GET · List Email Templates", "request": { "method": "GET", "header": [ { "key": "x-app-type", "value": "marketo", "type": "text", "description": "Application type header. Required, string. Allowed values: `marketo`." } ], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v2/emailtemplate/filter?workspaceId=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v2", "emailtemplate", "filter" ], "query": [ { "key": "workspaceId", "value": "", "description": "Not documented in the source specification. Required, string." }, { "key": "folderId", "value": "", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "folderType", "value": "", "description": "Not documented in the source specification. Optional, string. Allowed values: `Folder`, `Program`.", "disabled": true }, { "key": "status", "value": "", "description": "Not documented in the source specification. Optional, array of string. Repeat the parameter once per value: add another row with the same key for each additional value.", "disabled": true }, { "key": "pageIndex", "value": "", "description": "Not documented in the source specification. Optional, integer (int32).", "disabled": true }, { "key": "pageSize", "value": "", "description": "Maximum value is 50. Optional, integer (int32).", "disabled": true }, { "key": "createdAtEnd", "value": "", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "createdAtStart", "value": "", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "modifiedAtStart", "value": "", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "modifiedAtEnd", "value": "", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "name", "value": "", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "sortKey", "value": "", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "sortOrder", "value": "", "description": "Not documented in the source specification. Optional, string. Allowed values: `ASC`, `DESC`.", "disabled": true }, { "key": "isCreatedByMe", "value": "", "description": "Not documented in the source specification. Optional, boolean.", "disabled": true }, { "key": "isModifiedByMe", "value": "", "description": "Not documented in the source specification. Optional, boolean.", "disabled": true }, { "key": "scriptEngine", "value": "", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "isValueNonNullable", "value": "", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "includeArchived", "value": "", "description": "Not documented in the source specification. Optional, boolean.", "disabled": true } ] }, "description": "Filters and lists email templates by the given criteria. Required Permissions: Read-Only Assets, Access Design Studio, Access Email Template.\n\n- **Endpoint:** `GET /rest/asset/v2/emailtemplate/filter`\n- **Operation ID:** `filterContentUsingGET_emailtemplate`\n- **API:** Asset API · Email Templates (New)\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [List Email Templates on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/email-templates-new/list-email-templates/)\n\n### Parameters\n\n- `access_token` · not sent; see notes · string · required — Token for Authorization.\n- `x-app-type` · header · string · required · Allowed values: `marketo`\n- `workspaceId` · query param · string · required\n- `folderId` · query param · string · optional\n- `folderType` · query param · string · optional · Allowed values: `Folder`, `Program`\n- `status` · query param · array of string · optional\n- `pageIndex` · query param · integer (int32) · optional\n- `pageSize` · query param · integer (int32) · optional\n- `createdAtEnd` · query param · string · optional\n- `createdAtStart` · query param · string · optional\n- `modifiedAtStart` · query param · string · optional\n- `modifiedAtEnd` · query param · string · optional\n- `name` · query param · string · optional\n- `sortKey` · query param · string · optional\n- `sortOrder` · query param · string · optional · Allowed values: `ASC`, `DESC`\n- `isCreatedByMe` · query param · boolean · optional\n- `isModifiedByMe` · query param · boolean · optional\n- `scriptEngine` · query param · string · optional\n- `isValueNonNullable` · query param · string · optional\n- `includeArchived` · query param · boolean · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [EmailTemplateFilterResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/emailtemplatefilterresponse/)\n- `default` — Error · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/errorresponse/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n- `pageIndex`: Not documented in the source specification.\n- `pageSize`: Maximum value is 50.\n\nThe source specification does not describe `pageIndex`, so this collection does not say whether it counts records or pages. See the [reference page](https://mkto-ref.harrisonjennings.au/reference/asset/email-templates-new/list-email-templates/), and send each page as a separate request.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value.\n\n### Notes\n\n- The source specification also lists an `access_token` query parameter. This collection sends the token in the `Authorization` header instead, so it is never added to URLs." } }, { "id": "7edf6629-deb6-5e08-b423-5fef5f5778ed", "name": "POST · Update Email Template Status", "request": { "method": "POST", "header": [ { "key": "x-app-type", "value": "marketo", "type": "text", "description": "Application type header. Required, string. Allowed values: `marketo`." } ], "body": { "mode": "raw", "raw": "{\n \"contentId\": null,\n \"action\": null\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v2/emailtemplate/state/transition", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v2", "emailtemplate", "state", "transition" ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nPerforms a state transition on an email template. Required Permissions: Read-Write Assets, Access Design Studio, Approve Email Template.\n\n- **Endpoint:** `POST /rest/asset/v2/emailtemplate/state/transition`\n- **Operation ID:** `stateTransitionUsingPOST_emailtemplate`\n- **API:** Asset API · Email Templates (New)\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Email Template Status on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/email-templates-new/update-email-template-status/)\n\n### Parameters\n\n- `access_token` · not sent; see notes · string · required — Token for Authorization.\n- `x-app-type` · header · string · required · Allowed values: `marketo`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [StateTransitionRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/statetransitionrequest/)\n\nThe body starts with the required properties only, set to `null`. Replace each `null` with a value, and add any optional properties you need.\n\n**Properties**\n\n- `contentId` · string · required — Not documented in the source specification.\n- `action` · string · required — The state transition action to perform on the asset. Allowed values: `approve`, `unapprove`, `discard`, `create_draft`.\n\n### Responses\n\n- `200` — OK · [EmailTemplateNewResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/emailtemplatenewresponse/)\n- `default` — Error · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/errorresponse/)\n\nDeclared response media type: `application/json`.\n\n### Notes\n\n- The source specification also lists an `access_token` query parameter. This collection sends the token in the `Authorization` header instead, so it is never added to URLs." } }, { "id": "91744ad4-aaef-54ff-a288-3a98d1ee935c", "name": "POST · Get Email Template Used By", "request": { "method": "POST", "header": [ { "key": "x-app-type", "value": "marketo", "type": "text", "description": "Application type header. Required, string. Allowed values: `marketo`." } ], "body": { "mode": "raw", "raw": "{\n \"assetId\": null\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v2/emailtemplate/usedby", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v2", "emailtemplate", "usedby" ] }, "description": "Returns a list of assets that reference the specified email template. Required Permissions: Read-Only Assets, Access Design Studio.\n\n- **Endpoint:** `POST /rest/asset/v2/emailtemplate/usedby`\n- **Operation ID:** `getContentUsedByUsingPOST_emailtemplate`\n- **API:** Asset API · Email Templates (New)\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Email Template Used By on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/email-templates-new/get-email-template-used-by/)\n\n### Parameters\n\n- `access_token` · not sent; see notes · string · required — Token for Authorization.\n- `x-app-type` · header · string · required · Allowed values: `marketo`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [UsedByRequestDto](https://mkto-ref.harrisonjennings.au/reference/asset/models/usedbyrequestdto/)\n\nThe body starts with the required properties only, set to `null`. Replace each `null` with a value, and add any optional properties you need.\n\n**Properties**\n\n- `assetId` · string · required — Not documented in the source specification.\n- `pageIndex` · integer (int32) · optional — Not documented in the source specification.\n- `pageSize` · integer (int32) · optional — Not documented in the source specification.\n- `type` · string · optional — Not documented in the source specification.\n\n### Responses\n\n- `200` — OK · [UsedByResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/usedbyresponse/)\n- `default` — Error · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/errorresponse/)\n\nDeclared response media type: `application/json`.\n\n### Notes\n\n- The source specification also lists an `access_token` query parameter. This collection sends the token in the `Authorization` header instead, so it is never added to URLs." } }, { "id": "67fe9586-41e7-581a-8490-4f18af4f54cd", "name": "GET · Get Email Template by Id", "request": { "method": "GET", "header": [ { "key": "x-app-type", "value": "marketo", "type": "text", "description": "Application type header. Required, string. Allowed values: `marketo`." } ], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v2/emailtemplate/:id", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v2", "emailtemplate", ":id" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, string." } ] }, "description": "Retrieves an email template by its ID. Required Permissions: Read-Only Assets, Access Design Studio, Access Email Template.\n\n- **Endpoint:** `GET /rest/asset/v2/emailtemplate/{id}`\n- **Operation ID:** `getContentUsingGET_emailtemplate`\n- **API:** Asset API · Email Templates (New)\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Email Template by Id on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/email-templates-new/get-email-template-by-id/)\n\n### Parameters\n\n- `access_token` · not sent; see notes · string · required — Token for Authorization.\n- `x-app-type` · header · string · required · Allowed values: `marketo`\n- `id` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [EmailTemplateNewResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/emailtemplatenewresponse/)\n- `default` — Error · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/errorresponse/)\n\nDeclared response media type: `application/json`.\n\n### Notes\n\n- The source specification also lists an `access_token` query parameter. This collection sends the token in the `Authorization` header instead, so it is never added to URLs." } }, { "id": "675e77aa-e9b4-5039-b0fa-61a5ada55e8f", "name": "POST · Delete Email Template", "request": { "method": "POST", "header": [ { "key": "x-app-type", "value": "marketo", "type": "text", "description": "Application type header. Required, string. Allowed values: `marketo`." } ], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v2/emailtemplate/:id/delete", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v2", "emailtemplate", ":id", "delete" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, string." } ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDeletes an email template by its ID. Required Permissions: Read-Write Assets, Access Design Studio, Delete Email Template.\n\n- **Endpoint:** `POST /rest/asset/v2/emailtemplate/{id}/delete`\n- **Operation ID:** `deleteContentUsingPOST_emailtemplate`\n- **API:** Asset API · Email Templates (New)\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete Email Template on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/email-templates-new/delete-email-template/)\n\n### Parameters\n\n- `access_token` · not sent; see notes · string · required — Token for Authorization.\n- `x-app-type` · header · string · required · Allowed values: `marketo`\n- `id` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [DeleteResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/deleteresponse/)\n- `default` — Error · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/errorresponse/)\n\nDeclared response media type: `application/json`.\n\n### Notes\n\n- The source specification also lists an `access_token` query parameter. This collection sends the token in the `Authorization` header instead, so it is never added to URLs." } }, { "id": "7eafec8a-68db-5617-8143-c4f7c0ea132c", "name": "POST · Update Email Template", "request": { "method": "POST", "header": [ { "key": "x-app-type", "value": "marketo", "type": "text", "description": "Application type header. Required, string. Allowed values: `marketo`." } ], "body": { "mode": "raw", "raw": "{}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v2/emailtemplate/:id/update", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v2", "emailtemplate", ":id", "update" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, string." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdates an existing email template. Required Permissions: Read-Write Assets, Access Design Studio, Edit Email Template.\n\n- **Endpoint:** `POST /rest/asset/v2/emailtemplate/{id}/update`\n- **Operation ID:** `updateContentUsingPOST_emailtemplate`\n- **API:** Asset API · Email Templates (New)\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Email Template on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/email-templates-new/update-email-template/)\n\n### Parameters\n\n- `access_token` · not sent; see notes · string · required — Token for Authorization.\n- `x-app-type` · header · string · required · Allowed values: `marketo`\n- `id` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · optional · model [UpdateEmailTemplateRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/updateemailtemplaterequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `name` · string · optional — Not documented in the source specification.\n- `description` · string · optional — Not documented in the source specification.\n- `data` · DataDTO · optional — Not documented in the source specification.\n- `data.html` · HtmlDataDTO · optional — Not documented in the source specification.\n- `data.html.body` · string · optional — Not documented in the source specification.\n- `data.text` · TextDataDTO · optional — Not documented in the source specification.\n- `data.text.body` · string · optional — Not documented in the source specification.\n- `data.text.syncFromHtml` · boolean · optional — Not documented in the source specification.\n- `editorContext` · EditorContextDto · optional — Not documented in the source specification.\n- `editorContext.dynamicContent` · object · optional — Not documented in the source specification.\n\n### Responses\n\n- `200` — OK · [EmailTemplateNewResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/emailtemplatenewresponse/)\n- `default` — Error · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/errorresponse/)\n\nDeclared response media type: `application/json`.\n\n### Notes\n\n- The source specification also lists an `access_token` query parameter. This collection sends the token in the `Authorization` header instead, so it is never added to URLs." } }, { "id": "f79b3d8d-3e19-5af5-b764-c4b4b5d78295", "name": "POST · Bulk Get Email Templates", "request": { "method": "POST", "header": [ { "key": "x-app-type", "value": "", "type": "text", "description": "Application type header. Required, string." } ], "body": { "mode": "raw", "raw": "{\n \"assetIds\": []\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v2/emailtemplate/bulk/get", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v2", "emailtemplate", "bulk", "get" ] }, "description": "Retrieves multiple email templates by their IDs in a single request; each asset is returned in full, including its content. Maximum 20 assets per request. Required Permissions: Read-Only Assets, Access Design Studio, Access Email Template.\n\n- **Endpoint:** `POST /rest/asset/v2/emailtemplate/bulk/get`\n- **Operation ID:** `bulkGetUsingPOST_emailtemplate`\n- **API:** Asset API · Email Templates (New)\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Bulk Get Email Templates on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/email-templates-new/bulk-get-email-templates/)\n\n### Parameters\n\n- `access_token` · not sent; see notes · string · required — Token for Authorization.\n- `x-app-type` · header · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [BulkGetRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/bulkgetrequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `assetIds` · array of string · required — Set of asset IDs to retrieve. Maximum 20 per request.\n\n### Responses\n\n- `200` — OK · [EmailTemplateNewResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/emailtemplatenewresponse/)\n- `default` — Error · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/errorresponse/)\n\nDeclared response media type: `application/json`.\n\n### Notes\n\n- The source specification also lists an `access_token` query parameter. This collection sends the token in the `Authorization` header instead, so it is never added to URLs." } }, { "id": "b5e2e131-c4e2-58c0-91d2-83f8a89136e4", "name": "POST · Bulk Delete Email Templates", "request": { "method": "POST", "header": [ { "key": "x-app-type", "value": "", "type": "text", "description": "Application type header. Required, string." } ], "body": { "mode": "raw", "raw": "{\n \"assetIds\": []\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v2/emailtemplate/bulk/delete", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v2", "emailtemplate", "bulk", "delete" ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDeletes multiple email templates by their IDs in a single request. Maximum 20 assets per request. Required Permissions: Read-Write Assets, Access Design Studio, Delete Email Template.\n\n- **Endpoint:** `POST /rest/asset/v2/emailtemplate/bulk/delete`\n- **Operation ID:** `bulkDeleteUsingPOST_emailtemplate`\n- **API:** Asset API · Email Templates (New)\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Bulk Delete Email Templates on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/email-templates-new/bulk-delete-email-templates/)\n\n### Parameters\n\n- `access_token` · not sent; see notes · string · required — Token for Authorization.\n- `x-app-type` · header · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [BulkDeleteRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/bulkdeleterequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `assetIds` · array of string · required — Set of asset IDs to delete. Maximum 20 per request.\n- `ignoreUsedBy` · boolean · optional — If true, deletes assets even if they are referenced by other assets.\n\n### Responses\n\n- `200` — OK · [DeleteResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/deleteresponse/)\n- `default` — Error · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/errorresponse/)\n\nDeclared response media type: `application/json`.\n\n### Notes\n\n- The source specification also lists an `access_token` query parameter. This collection sends the token in the `Authorization` header instead, so it is never added to URLs." } }, { "id": "419d9b39-970e-5368-8c58-47bc9ab8fe2b", "name": "POST · Bulk Get Email Templates Used By", "request": { "method": "POST", "header": [ { "key": "x-app-type", "value": "", "type": "text", "description": "Application type header. Required, string." } ], "body": { "mode": "raw", "raw": "{\n \"assetIds\": []\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v2/emailtemplate/bulk/usedby", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v2", "emailtemplate", "bulk", "usedby" ] }, "description": "Returns, for each of the specified email templates, whether it is used and the number of places it is used (count) — not the referencing assets themselves. Maximum 50 assets per request. Required Permissions: Read-Only Assets, Access Design Studio.\n\n- **Endpoint:** `POST /rest/asset/v2/emailtemplate/bulk/usedby`\n- **Operation ID:** `bulkUsedByUsingPOST_emailtemplate`\n- **API:** Asset API · Email Templates (New)\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Bulk Get Email Templates Used By on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/email-templates-new/bulk-get-email-templates-used-by/)\n\n### Parameters\n\n- `access_token` · not sent; see notes · string · required — Token for Authorization.\n- `x-app-type` · header · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [BulkUsedByRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/bulkusedbyrequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `assetIds` · array of string · required — Asset IDs to query. Maximum 50 per request.\n\n### Responses\n\n- `200` — OK · [BulkUsedByResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/bulkusedbyresponse/)\n- `default` — Error · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/errorresponse/)\n\nDeclared response media type: `application/json`.\n\n### Notes\n\n- The source specification also lists an `access_token` query parameter. This collection sends the token in the `Authorization` header instead, so it is never added to URLs." } } ] }, { "id": "bc915533-970b-5f40-8837-d3bcfd28378a", "name": "Emails", "description": "Emails operations in the Asset API. Reference: [Emails](https://mkto-ref.harrisonjennings.au/reference/asset/emails/).", "item": [ { "id": "7046c187-f8ac-5205-a184-db82c2024104", "name": "GET · Get Email by Name", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/email/byName.json?name=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "email", "byName.json" ], "query": [ { "key": "name", "value": "", "description": "Name of the email. Required, string." }, { "key": "status", "value": "", "description": "Status filter for draft or approved versions. Optional, string. Allowed values: `approved`, `draft`.", "disabled": true }, { "key": "folder", "value": "", "description": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'. Optional, string.", "disabled": true } ] }, "description": "Returns email records based on the given name. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/email/byName.json`\n- **Operation ID:** `getEmailByNameUsingGET`\n- **API:** Asset API · Emails\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Email by Name on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/emails/get-email-by-name/)\n\n### Parameters\n\n- `name` · query param · string · required\n- `status` · query param · string · optional · Allowed values: `approved`, `draft`\n- `folder` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfEmailResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofemailresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "be6ddb13-9f7c-56d8-a275-6fe067abd4de", "name": "GET · Get Email By Id", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/email/:id.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "email", ":id.json" ], "query": [ { "key": "status", "value": "", "description": "Status filter for draft or approved versions. Optional, string. Allowed values: `approved`, `draft`.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "Returns an email record by its id. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/email/{id}.json`\n- **Operation ID:** `getEmailByIdUsingGET`\n- **API:** Asset API · Emails\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Email By Id on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/emails/get-email-by-id/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `status` · query param · string · optional · Allowed values: `approved`, `draft`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfEmailResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofemailresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "df7f24e1-84ab-5ab2-9179-42daf052bfef", "name": "POST · Update Email Metadata", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "description", "value": "", "type": "text", "description": "Description of the asset. Optional, string.", "disabled": true }, { "key": "name", "value": "", "type": "text", "description": "Name of the Email. Optional, string.", "disabled": true }, { "key": "preHeader", "value": "", "type": "text", "description": "Preheader text for the email. Optional, string.", "disabled": true }, { "key": "operational", "value": "", "type": "text", "description": "Whether the email is operational. Operational emails bypass unsubscribe status. Defaults to false. Optional, boolean.", "disabled": true }, { "key": "published", "value": "", "type": "text", "description": "Whether the email has been published to Sales Insight. Default false. Optional, boolean.", "disabled": true }, { "key": "textOnly", "value": "", "type": "text", "description": "Setting to include text-only version of email when sent. Optional, boolean.", "disabled": true }, { "key": "webView", "value": "", "type": "text", "description": "Whether the email has been enabled to allow the 'View as Web Page' when received. Optional, boolean.", "disabled": true }, { "key": "autoCopyToText", "value": "", "type": "text", "description": "Setting to automatically copy HTML version to Text version. Optional, boolean.", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/email/:id.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "email", ":id.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdates the metadata of an email asset. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/email/{id}.json`\n- **Operation ID:** `updateEmailUsingPOST`\n- **API:** Asset API · Emails\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Email Metadata on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/emails/update-email-metadata/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [UpdateEmailMetaDataRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/updateemailmetadatarequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n### Responses\n\n- `200` — OK · [ResponseOfEmailResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofemailresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "7c520006-85bd-5926-b934-cec27dcfd41a", "name": "POST · Approve Email Draft", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/email/:id/approveDraft.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "email", ":id", "approveDraft.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request approves an asset in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nApproves the current draft of an email. Required Permissions: Approve Assets\n\n- **Endpoint:** `POST /rest/asset/v1/email/{id}/approveDraft.json`\n- **Operation ID:** `approveDraftUsingPOST`\n- **API:** Asset API · Emails\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Approve Email Draft on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/emails/approve-email-draft/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "e44151af-b7f5-5041-909e-c897bcf1a589", "name": "POST · Clone Email", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "description", "value": "", "type": "text", "description": "Description of the asset. Optional, string.", "disabled": true }, { "key": "folder", "value": "", "type": "text", "description": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'. Required, Folder. Send the value as JSON text; its properties are listed in the request description." }, { "key": "name", "value": "", "type": "text", "description": "Name of the new email asset. Required, string." }, { "key": "operational", "value": "", "type": "text", "description": "Whether the email is operational. Operational emails bypass unsubscribe status. Defaults to false. Optional, boolean.", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/email/:id/clone.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "email", ":id", "clone.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request creates a copy of an asset in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nClones the target email. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/email/{id}/clone.json`\n- **Operation ID:** `cloneEmailUsingPOST`\n- **API:** Asset API · Emails\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Clone Email on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/emails/clone-email/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [CloneEmailRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/cloneemailrequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n**Properties of JSON-valued fields**\n\n- `folder.id` · integer (int32) · required — Id of the folder.\n- `folder.type` · string · required — Type of folder. Allowed values: `Folder`, `Program`.\n\n### Responses\n\n- `200` — OK · [ResponseOfEmailResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofemailresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "e85fe8dd-7adc-57db-91c8-0a50ab89bb46", "name": "GET · Get Email Content", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/email/:id/content.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "email", ":id", "content.json" ], "query": [ { "key": "status", "value": "", "description": "Status filter for draft or approved versions. Optional, string. Allowed values: `approved`, `draft`.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "Returns the content of the designated email. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/email/{id}/content.json`\n- **Operation ID:** `getEmailContentByIdUsingGET`\n- **API:** Asset API · Emails\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Email Content on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/emails/get-email-content/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `status` · query param · string · optional · Allowed values: `approved`, `draft`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfEmailContentResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofemailcontentresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "d2e0dcc1-ce0b-5aa5-82e0-626dc7fcf388", "name": "POST · Update Email Content", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "fromEmail", "value": "", "type": "text", "description": "From-address of the Email. Optional, EmailHeaderField. Send the value as JSON text; its properties are listed in the request description.", "disabled": true }, { "key": "fromName", "value": "", "type": "text", "description": "From-name of the Email. Optional, EmailHeaderField. Send the value as JSON text; its properties are listed in the request description.", "disabled": true }, { "key": "replyTO", "value": "", "type": "text", "description": "Reply-To address of the Email. Optional, EmailHeaderField. Send the value as JSON text; its properties are listed in the request description.", "disabled": true }, { "key": "subject", "value": "", "type": "text", "description": "Subject Line of the Email. Optional, EmailHeaderField. Send the value as JSON text; its properties are listed in the request description.", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/email/:id/content.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "email", ":id", "content.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdates the content of an email. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/email/{id}/content.json`\n- **Operation ID:** `updateEmailContentUsingPOST`\n- **API:** Asset API · Emails\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Email Content on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/emails/update-email-content/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [UpdateEmailComponentDataRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/updateemailcomponentdatarequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n**Properties of JSON-valued fields**\n\n- `fromEmail.type` · string · required — Field type.\n- `fromEmail.value` · string · required — Value of field.\n- `fromName.type` · string · required — Field type.\n- `fromName.value` · string · required — Value of field.\n- `replyTO.type` · string · required — Field type.\n- `replyTO.value` · string · required — Value of field.\n- `subject.type` · string · required — Field type.\n- `subject.value` · string · required — Value of field.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "70613a03-91c3-54bc-9be8-56f71c2f8d26", "name": "POST · Rearrange Email Modules", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "positions", "value": "", "type": "text", "description": "JSON array of module positions. Each position must be a JSON object with members 'index' and a 'moduleId'. Optional, string.", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/email/:id/content/rearrange.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "email", ":id", "content", "rearrange.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request changes the arrangement of an asset in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nRearranges the modules in an email. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/email/{id}/content/rearrange.json`\n- **Operation ID:** `rearrangeModulesUsingPOST`\n- **API:** Asset API · Emails\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Rearrange Email Modules on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/emails/rearrange-email-modules/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · optional\n\nJSON array of module positions. Each position must be a JSON object with members 'index' and a 'moduleId'\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n### Responses\n\n- `200` — OK · [ResponseOfEmailModuleResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofemailmoduleresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "92cab1c3-6a6d-5629-9013-79a4b51dd893", "name": "POST · Update Email Content Section", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "altText", "value": "", "type": "text", "description": "Sets the value of the alt parameter for the resulting img element. Optional, string.", "disabled": true }, { "key": "externalUrl", "value": "", "type": "text", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "height", "value": "", "type": "text", "description": "Overrides naitve height of the image. The resulting file will be resized to the given height. Optional, integer (int32).", "disabled": true }, { "key": "image", "value": "", "type": "text", "description": "Multipart file that allows you to load an image from your computer. Optional, string.", "disabled": true }, { "key": "linkUrl", "value": "", "type": "text", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "overWrite", "value": "", "type": "text", "description": "Allows overwriting of the existing image content section. Optional, boolean.", "disabled": true }, { "key": "style", "value": "", "type": "text", "description": "Sets the value of the style parameter for the content section. Optional, string.", "disabled": true }, { "key": "textValue", "value": "", "type": "text", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "type", "value": "", "type": "text", "description": "Type of content to set for the section. Required, string. Allowed values: `Text`, `DynamicContent`, `Snippet`." }, { "key": "value", "value": "", "type": "text", "description": "Value to set for the section. For type Text, the HTML content of the section. For type DynamicContent, the id of the segmentation to use for the content. For type Snippet, the id of the snippet to embed. Required, string." }, { "key": "videoUrl", "value": "", "type": "text", "description": "Sets the Url of the video element. Videos must be either from YouTube or Vimeo. Optional, string.", "disabled": true }, { "key": "width", "value": "", "type": "text", "description": "Overrides native width of the image. The resulting file will be resized to the given width. Optional, integer (int32).", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/email/:id/content/:htmlId.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "email", ":id", "content", ":htmlId.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." }, { "key": "htmlId", "value": "", "description": "htmlId. Required, string." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdates the content in the given section. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/email/{id}/content/{htmlId}.json`\n- **Operation ID:** `updateEmailComponentContentUsingPOST`\n- **API:** Asset API · Emails\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Email Content Section on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/emails/update-email-content-section/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `htmlId` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [UpdateEmailComponentContentRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/updateemailcomponentcontentrequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "f1b0b927-0a7d-5e04-a8d3-1481d204f48f", "name": "POST · Add Email Module", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/email/:id/content/:moduleId/add.json?name=&index=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "email", ":id", "content", ":moduleId", "add.json" ], "query": [ { "key": "name", "value": "", "description": "Name of the module. Required, string." }, { "key": "index", "value": "", "description": "Index of the module. Determines the order of the module in the email. Required, integer (int32)." } ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." }, { "key": "moduleId", "value": "", "description": "moduleId. Required, string." } ] }, "description": "> **Changes data.** Sending this request adds records or associations in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nAdds a new module to an email, with the given id. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/email/{id}/content/{moduleId}/add.json`\n- **Operation ID:** `addModuleUsingPOST`\n- **API:** Asset API · Emails\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Add Email Module on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/emails/add-email-module/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `moduleId` · path variable · string · required\n- `name` · query param · string · required\n- `index` · query param · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfEmailModuleResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofemailmoduleresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "0e78fe33-2d8a-56e0-8e1c-db46ab2fc163", "name": "POST · Delete Module", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/email/:id/content/:moduleId/delete.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "email", ":id", "content", ":moduleId", "delete.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." }, { "key": "moduleId", "value": "", "description": "moduleId. Required, string." } ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDeletes the given module from the email. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/email/{id}/content/{moduleId}/delete.json`\n- **Operation ID:** `deleteModuleUsingPOST`\n- **API:** Asset API · Emails\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete Module on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/emails/delete-module/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `moduleId` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfEmailModuleResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofemailmoduleresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "00260bdf-3593-55cf-81c2-b6c2073d9cb9", "name": "POST · Duplicate Email Module", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/email/:id/content/:moduleId/duplicate.json?name=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "email", ":id", "content", ":moduleId", "duplicate.json" ], "query": [ { "key": "name", "value": "", "description": "Name of the new module. Required, string." } ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." }, { "key": "moduleId", "value": "", "description": "moduleId. Required, string." } ] }, "description": "> **Changes data.** Sending this request creates a copy of an asset in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nCreates a copy of the designated module in an email. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/email/{id}/content/{moduleId}/duplicate.json`\n- **Operation ID:** `duplicateModuleUsingPOST`\n- **API:** Asset API · Emails\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Duplicate Email Module on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/emails/duplicate-email-module/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `moduleId` · path variable · string · required\n- `name` · query param · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfEmailModuleResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofemailmoduleresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "d82ec0f7-484a-5304-a117-4598072418da", "name": "POST · Rename Email Module", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/email/:id/content/:moduleId/rename.json?name=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "email", ":id", "content", ":moduleId", "rename.json" ], "query": [ { "key": "name", "value": "", "description": "New module name. Required, string." } ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." }, { "key": "moduleId", "value": "", "description": "moduleId. Required, string." } ] }, "description": "> **Changes data.** Sending this request renames data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nRenames a module. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/email/{id}/content/{moduleId}/rename.json`\n- **Operation ID:** `renameUsingPOST`\n- **API:** Asset API · Emails\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Rename Email Module on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/emails/rename-email-module/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `moduleId` · path variable · string · required\n- `name` · query param · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfEmailModuleResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofemailmoduleresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "880f2374-f011-5fe6-b07e-f9cb28940c5d", "name": "POST · Delete Email", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/email/:id/delete.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "email", ":id", "delete.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDeletes the target email. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/email/{id}/delete.json`\n- **Operation ID:** `deleteEmailUsingPOST`\n- **API:** Asset API · Emails\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete Email on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/emails/delete-email/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "e817cd1b-4a52-5559-912a-5b6f0cc90a17", "name": "POST · Discard Email Draft", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/email/:id/discardDraft.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "email", ":id", "discardDraft.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request discards a draft in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDiscards the current draft of an email. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/email/{id}/discardDraft.json`\n- **Operation ID:** `discardDraftUsingPOST`\n- **API:** Asset API · Emails\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Discard Email Draft on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/emails/discard-email-draft/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "895e8bbf-3350-5bc4-af9d-3e1f88c451ef", "name": "GET · Get Email Dynamic Content", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/email/:id/dynamicContent/:contentId.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "email", ":id", "dynamicContent", ":contentId.json" ], "query": [ { "key": "status", "value": "", "description": "Status filter for draft or approved versions. Optional, string. Allowed values: `approved`, `draft`.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "Id of email. Required, integer (int32)." }, { "key": "contentId", "value": "", "description": "Id of email dynamic content section. Required, string." } ] }, "description": "Retrieves the dynamic content record for the given section. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/email/{id}/dynamicContent/{contentId}.json`\n- **Operation ID:** `getEmailDynamicContentUsingGET`\n- **API:** Asset API · Emails\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Email Dynamic Content on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/emails/get-email-dynamic-content/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `contentId` · path variable · string · required\n- `status` · query param · string · optional · Allowed values: `approved`, `draft`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfEmailDynamicContentResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofemaildynamiccontentresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "f0d174c8-2f7f-5471-ad6c-3509b903e676", "name": "POST · Update Email Dynamic Content Section", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "altText", "value": "", "type": "text", "description": "Sets the value of the alt parameter for the resulting img element. Optional, string.", "disabled": true }, { "key": "externalUrl", "value": "", "type": "text", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "height", "value": "", "type": "text", "description": "Overrides naitve height of the image. The resulting file will be resized to the given height. Optional, integer (int32).", "disabled": true }, { "key": "image", "value": "", "type": "text", "description": "Multipart file that allows you to add an image from your computer. Optional, string.", "disabled": true }, { "key": "linkUrl", "value": "", "type": "text", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "overWrite", "value": "", "type": "text", "description": "Allows overwriting of the existing image content section. Optional, boolean.", "disabled": true }, { "key": "style", "value": "", "type": "text", "description": "Sets the value of the style parameter for the content section. Optional, string.", "disabled": true }, { "key": "type", "value": "", "type": "text", "description": "Type of content to set for the section. Required, string. Allowed values: `Text`, `DynamicContent`, `Snippet`." }, { "key": "value", "value": "", "type": "text", "description": "Value to set for the section. For type Text, the HTML content of the section. For type DynamicContent, the id of the segmentation to use for the content. For type Snippet, the id of the snippet to embed. Required, string." }, { "key": "videoUrl", "value": "", "type": "text", "description": "Sets the Url of the video element. Videos must be either from YouTube or Vimeo. Optional, string.", "disabled": true }, { "key": "width", "value": "", "type": "text", "description": "Overrides native width of the image. The resulting file will be resized to the given width. Optional, integer (int32).", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/email/:id/dynamicContent/:contentId.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "email", ":id", "dynamicContent", ":contentId.json" ], "variable": [ { "key": "id", "value": "", "description": "Id of email. Required, integer (int32)." }, { "key": "contentId", "value": "", "description": "Id of email dynamic content section. Required, string." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdates dynamic content in the given section. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/email/{id}/dynamicContent/{contentId}.json`\n- **Operation ID:** `updateEmailDynamicContentUsingPOST`\n- **API:** Asset API · Emails\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Email Dynamic Content Section on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/emails/update-email-dynamic-content-section/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `contentId` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [UpdateEmailDynamicContentRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/updateemaildynamiccontentrequest/)\n\nContent properties\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "6e8dac0a-7b62-5a5f-a27e-e13809394992", "name": "POST · Send Sample Email", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "emailAddress", "value": "", "type": "text", "description": "Email address to receive sample email. Required, string." }, { "key": "leadId", "value": "", "type": "text", "description": "Id of a lead to impersonate. Tokens and dynamic content will be populated as though it were sent to the lead. Optional, string.", "disabled": true }, { "key": "textOnly", "value": "", "type": "text", "description": "Whether to send to text only version along with the HTML version. Default false. Optional, boolean.", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/email/:id/sendSample.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "email", ":id", "sendSample.json" ], "variable": [ { "key": "id", "value": "", "description": "Id of the email. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request sends an email from the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nSends 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\n\n- **Endpoint:** `POST /rest/asset/v1/email/{id}/sendSample.json`\n- **Operation ID:** `sendSampleEmailUsingPOST`\n- **API:** Asset API · Emails\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Send Sample Email on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/emails/send-sample-email/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [SendSampleEmailRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/sendsampleemailrequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n### Responses\n\n- `200` — OK · [ResponseOfSendSampleResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsendsampleresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "ec9d6782-0800-55d2-85aa-9fba8c4e2191", "name": "POST · Unapprove Email", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/email/:id/unapprove.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "email", ":id", "unapprove.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request unapproves an asset in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUnapproves the email and reverts it to a draft-only state. Required Permissions: Approve Assets\n\n- **Endpoint:** `POST /rest/asset/v1/email/{id}/unapprove.json`\n- **Operation ID:** `unapproveDraftUsingPOST`\n- **API:** Asset API · Emails\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Unapprove Email on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/emails/unapprove-email/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "5687faa7-2049-5ed5-94a7-0e56ebc6067f", "name": "POST · Update Email Variable", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "value", "value": "", "type": "text", "description": "Value to update variable with. Optional, string.", "disabled": true }, { "key": "moduleId", "value": "", "type": "text", "description": "Module that variable is associated with. Required for updating module variables. Not needed for global variables. Optional, string.", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/email/:id/variable/:name.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "email", ":id", "variable", ":name.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." }, { "key": "name", "value": "", "description": "name. Required, string." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdates the value of a given variable in an email. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/email/{id}/variable/{name}.json`\n- **Operation ID:** `updateVariableUsingPOST`\n- **API:** Asset API · Emails\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Email Variable on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/emails/update-email-variable/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `name` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · optional · model [UpdateVariableRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/updatevariablerequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n### Responses\n\n- `200` — OK · [ResponseOfEmailVariableResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofemailvariableresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "cca394c8-1887-507f-9fe4-5863f36b7274", "name": "GET · Get Email Variables", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/email/:id/variables.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "email", ":id", "variables.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "Returns a list of the available variables in an email. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/email/{id}/variables.json`\n- **Operation ID:** `getEmailVariablesUsingGET`\n- **API:** Asset API · Emails\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Email Variables on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/emails/get-email-variables/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfEmailVariableResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofemailvariableresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "37af24ce-1e2c-5328-8362-d80efe27c77b", "name": "GET · Get Email CC Fields", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/email/ccFields.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "email", "ccFields.json" ] }, "description": "Returns the set of fields enabled for Email CC in the target instance. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/email/ccFields.json`\n- **Operation ID:** `getEmailCCFieldsUsingGET`\n- **API:** Asset API · Emails\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Email CC Fields on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/emails/get-email-cc-fields/)\n\n### Responses\n\n- `200` — OK · [ResponseOfEmailCCFieldsResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofemailccfieldsresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "4675c931-4049-5559-9ec3-d2ab8ff4bb65", "name": "GET · Get Emails", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/emails.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "emails.json" ], "query": [ { "key": "status", "value": "", "description": "Status filter for draft or approved versions. Optional, string. Allowed values: `approved`, `draft`.", "disabled": true }, { "key": "folder", "value": "", "description": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'. Optional, string.", "disabled": true }, { "key": "offset", "value": "", "description": "Integer offset for paging. Optional, integer (int32).", "disabled": true }, { "key": "maxReturn", "value": "", "description": "Maximum number of emails to return. Max 200, default 20. Optional, integer (int32).", "disabled": true }, { "key": "earliestUpdatedAt", "value": "", "description": "Exclude emails prior to this date. Must be valid ISO-8601 string. See Datetime (http://developers.marketo.com/rest-api/lead-database/fields/field-types/) field type description. Optional, string.", "disabled": true }, { "key": "latestUpdatedAt", "value": "", "description": "Exclude emails after this date. Must be valid ISO-8601 string. See Datetime (http://developers.marketo.com/rest-api/lead-database/fields/field-types/) field type description. Optional, string.", "disabled": true } ] }, "description": "Returns a list of emails matching the given filter parameters. Required Permissions: Read-Only Assets, Read-Write Assets.\n\nNote: Emails created with the new email designer may appear in this API's response, but some of the fields may be null or incomplete. For complete and reliable details of these assets, use the Emails (New) APIs; refer to the [List Emails](https://developer.adobe.com/marketo-apis/api/asset#operation/filterContentUsingGET_email) endpoint.\n\n- **Endpoint:** `GET /rest/asset/v1/emails.json`\n- **Operation ID:** `getEmailUsingGET`\n- **API:** Asset API · Emails\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Emails on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/emails/get-emails/)\n\n### Parameters\n\n- `status` · query param · string · optional · Allowed values: `approved`, `draft`\n- `folder` · query param · string · optional\n- `offset` · query param · integer (int32) · optional\n- `maxReturn` · query param · integer (int32) · optional\n- `earliestUpdatedAt` · query param · string · optional\n- `latestUpdatedAt` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfEmailResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofemailresponse/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n- `offset`: Integer offset for paging.\n- `maxReturn`: Maximum number of emails to return. Max 200, default 20.\n\nAdobe's [Asset API documentation](https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/assets/assets) describes `offset` as the position at which to begin returning results, not a page number. To get the next page, add the `maxReturn` value you used to `offset` and send the request again.\n\nContinue until a response returns no more records. The source specification does not say that a page with fewer than `maxReturn` records is the last one.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "5177ea88-7497-5fbd-9fcc-725563575f60", "name": "POST · Create Email", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "description", "value": "", "type": "text", "description": "Description of the asset. Optional, string.", "disabled": true }, { "key": "folder", "value": "", "type": "text", "description": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'. Required, Folder. Send the value as JSON text; its properties are listed in the request description." }, { "key": "fromEmail", "value": "", "type": "text", "description": "From-address of the Email. Required, string." }, { "key": "fromName", "value": "", "type": "text", "description": "From-name of the Email. Required, string." }, { "key": "name", "value": "", "type": "text", "description": "Name of the email. Required, string." }, { "key": "operational", "value": "", "type": "text", "description": "Whether the email is operational. Operational emails bypass unsubscribe status. Defaults to false. Optional, boolean.", "disabled": true }, { "key": "replyEmail", "value": "", "type": "text", "description": "Reply-To address of the Email. Required, string." }, { "key": "subject", "value": "", "type": "text", "description": "Subject Line of the Email. Required, string." }, { "key": "template", "value": "", "type": "text", "description": "Id of the parent template. Required, integer (int32)." }, { "key": "textOnly", "value": "", "type": "text", "description": "Setting to include text-only version of email when sent. Optional, boolean.", "disabled": true }, { "key": "autoCopyToText", "value": "", "type": "text", "description": "Setting to automatically copy HTML version to Text version. Optional, boolean.", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/emails.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "emails.json" ] }, "description": "> **Changes data.** Sending this request creates data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nCreates a new email asset. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/emails.json`\n- **Operation ID:** `createEmailUsingPOST`\n- **API:** Asset API · Emails\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Create Email on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/emails/create-email/)\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [CreateEmailRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/createemailrequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n**Properties of JSON-valued fields**\n\n- `folder.id` · integer (int32) · required — Id of the folder.\n- `folder.type` · string · required — Type of folder. Allowed values: `Folder`, `Program`.\n\n### Responses\n\n- `200` — OK · [ResponseOfEmailResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofemailresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "2e816afc-0374-5bf8-a0af-c7aa48b6066e", "name": "GET · Get Email Full Content", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/email/:id/fullContent.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "email", ":id", "fullContent.json" ], "query": [ { "key": "status", "value": "", "description": "Status filter for draft or approved versions. Defaults to approved if asset is approved, draft if not. Optional, string. Allowed values: `approved`, `draft`.", "disabled": true }, { "key": "leadId", "value": "", "description": "The lead id to impersonate. Email is rendered as though it was received by this lead. Optional, integer (int32).", "disabled": true }, { "key": "type", "value": "", "description": "Email content type to return. Default is HTML. Optional, string. Allowed values: `Text`, `HTML`.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "Id of the email. Required, integer (int32)." } ] }, "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.\n\n- **Endpoint:** `GET /rest/asset/v1/email/{id}/fullContent.json`\n- **Operation ID:** `getEmailFullContentUsingGET`\n- **API:** Asset API · Emails\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Email Full Content on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/emails/get-email-full-content/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `status` · query param · string · optional · Allowed values: `approved`, `draft`\n- `leadId` · query param · integer (int32) · optional\n- `type` · query param · string · optional · Allowed values: `Text`, `HTML`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfGetEmailFullContentResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofgetemailfullcontentresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "177e6f32-0913-5679-9959-e3a9be7978bf", "name": "POST · Update Email Full Content", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "content", "type": "file", "description": "Multipart file. File containing HTML document to update with. File cannot include JavaScript or script tags. Required, file. Select a file in the Body tab before sending." } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/email/:id/fullContent.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "email", ":id", "fullContent.json" ], "variable": [ { "key": "id", "value": "", "description": "Id of the email. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nReplaces the HTML of an Email that has had its relationship broken from its template. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/email/{id}/fullContent.json`\n- **Operation ID:** `createEmailFullContentUsingPOST`\n- **API:** Asset API · Emails\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Email Full Content on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/emails/update-email-full-content/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`multipart/form-data` · required · model [UpdateEmailFullContentRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/updateemailfullcontentrequest/)\n\nContent is multipart file parameter\n\nEach form field is a row in the **Body** tab (form-data), with its description. Required fields are enabled; optional fields are disabled until you enable them. File fields have no file selected.\n\n### Responses\n\n- `200` — OK · [ResponseOfUpdateEmailFullContentResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofupdateemailfullcontentresponse/)\n\nDeclared response media type: `application/json`." } } ] }, { "id": "b70f06f0-764e-54c9-948d-91e59296bb48", "name": "Emails (New)", "description": "Emails (New) operations in the Asset API. Reference: [Emails (New)](https://mkto-ref.harrisonjennings.au/reference/asset/emails-new/).", "item": [ { "id": "5c2c09e2-adfd-57b7-a1a6-bec44b6263cf", "name": "POST · Create Email", "request": { "method": "POST", "header": [ { "key": "x-app-type", "value": "marketo", "type": "text", "description": "Application type header. Required, string. Allowed values: `marketo`." } ], "body": { "mode": "raw", "raw": "{\n \"name\": null,\n \"appData\": {},\n \"headers\": {\n \"subject\": null\n }\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v2/email", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v2", "email" ] }, "description": "> **Changes data.** Sending this request creates data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nCreates a new email asset. Required Permissions: Read-Write Assets, Access Design Studio, Edit Email.\n\n- **Endpoint:** `POST /rest/asset/v2/email`\n- **Operation ID:** `createContentUsingPOST_email`\n- **API:** Asset API · Emails (New)\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Create Email on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/emails-new/create-email/)\n\n### Parameters\n\n- `access_token` · not sent; see notes · string · required — Token for Authorization.\n- `x-app-type` · header · string · required · Allowed values: `marketo`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [CreateEmailV2Request](https://mkto-ref.harrisonjennings.au/reference/asset/models/createemailv2request/)\n\nThe body starts with the required properties only, set to `null`. Replace each `null` with a value, and add any optional properties you need.\n\n**Properties**\n\n- `name` · string · required — Not documented in the source specification.\n- `description` · string · optional — Not documented in the source specification.\n- `appData` · EmailAppDataDTO · required — Not documented in the source specification.\n- `appData.editorType` · string · optional — Not documented in the source specification.\n- `appData.folderId` · string · optional — Not documented in the source specification.\n- `appData.programId` · string · optional — Not documented in the source specification.\n- `appData.workspaceId` · string · optional — Not documented in the source specification.\n- `data` · DataDTO · optional — Not documented in the source specification.\n- `data.html` · HtmlDataDTO · optional — Not documented in the source specification.\n- `data.html.body` · string · optional — Not documented in the source specification.\n- `data.text` · TextDataDTO · optional — Not documented in the source specification.\n- `data.text.body` · string · optional — Not documented in the source specification.\n- `data.text.syncFromHtml` · boolean · optional — Not documented in the source specification.\n- `headers` · EmailHeadersDTO · required — Not documented in the source specification.\n- `headers.ccEmails` · array of string · optional — Not documented in the source specification.\n- `headers.fromEmail` · string · optional — Not documented in the source specification.\n- `headers.fromName` · string · optional — Not documented in the source specification.\n- `headers.preheader` · string · optional — Not documented in the source specification.\n- `headers.replyEmail` · string · optional — Not documented in the source specification.\n- `headers.subject` · string · required — Not documented in the source specification.\n- `editorContext` · EditorContextDto · optional — Not documented in the source specification.\n- `editorContext.dynamicContent` · object · optional — Not documented in the source specification.\n- `settings` · EmailSettingsDTO · optional — Not documented in the source specification.\n- `settings.brandedDomain` · string · optional — Not documented in the source specification.\n- `settings.dedicatedIp` · string · optional — Not documented in the source specification.\n- `settings.enableUrlTracking` · boolean · optional — Not documented in the source specification.\n- `settings.isOperational` · boolean · optional — Not documented in the source specification.\n- `settings.isTextOnly` · boolean · optional — Not documented in the source specification.\n- `settings.isWebPageView` · boolean · optional — Not documented in the source specification.\n- `templateId` · string · optional — When provided, the template's content overwrites any data sent in the request.\n\n### Responses\n\n- `200` — OK · [EmailNewResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/emailnewresponse/)\n- `default` — Error · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/errorresponse/)\n\nDeclared response media type: `application/json`.\n\n### Notes\n\n- The source specification also lists an `access_token` query parameter. This collection sends the token in the `Authorization` header instead, so it is never added to URLs." } }, { "id": "e3e92eb7-3f50-57d3-9071-68055e3e87db", "name": "POST · Clone Email", "request": { "method": "POST", "header": [ { "key": "x-app-type", "value": "marketo", "type": "text", "description": "Application type header. Required, string. Allowed values: `marketo`." } ], "body": { "mode": "raw", "raw": "{\n \"assetId\": null,\n \"newAsset\": {\n \"name\": null\n }\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v2/email/clone", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v2", "email", "clone" ] }, "description": "> **Changes data.** Sending this request creates a copy of an asset in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nClones an existing email asset. Required Permissions: Read-Write Assets, Access Design Studio, Edit Email.\n\n- **Endpoint:** `POST /rest/asset/v2/email/clone`\n- **Operation ID:** `cloneContentUsingPOST_email`\n- **API:** Asset API · Emails (New)\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Clone Email on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/emails-new/clone-email/)\n\n### Parameters\n\n- `access_token` · not sent; see notes · string · required — Token for Authorization.\n- `x-app-type` · header · string · required · Allowed values: `marketo`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [CloneAssetRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/cloneassetrequest/)\n\nThe body starts with the required properties only, set to `null`. Replace each `null` with a value, and add any optional properties you need.\n\n**Properties**\n\n- `assetId` · string · required — Not documented in the source specification.\n- `newAsset` · CloneNewAsset · required — Not documented in the source specification.\n- `newAsset.name` · string · required — Not documented in the source specification.\n- `newAsset.description` · string · optional — Not documented in the source specification.\n\n### Responses\n\n- `200` — OK · [EmailNewResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/emailnewresponse/)\n- `default` — Error · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/errorresponse/)\n\nDeclared response media type: `application/json`.\n\n### Notes\n\n- The source specification also lists an `access_token` query parameter. This collection sends the token in the `Authorization` header instead, so it is never added to URLs." } }, { "id": "470901e8-7e7c-5cfd-98df-84cc7fb2d82b", "name": "GET · List Emails", "request": { "method": "GET", "header": [ { "key": "x-app-type", "value": "marketo", "type": "text", "description": "Application type header. Required, string. Allowed values: `marketo`." } ], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v2/email/filter?workspaceId=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v2", "email", "filter" ], "query": [ { "key": "workspaceId", "value": "", "description": "Not documented in the source specification. Required, string." }, { "key": "folderId", "value": "", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "folderType", "value": "", "description": "Not documented in the source specification. Optional, string. Allowed values: `Folder`, `Program`.", "disabled": true }, { "key": "status", "value": "", "description": "Not documented in the source specification. Optional, array of string. Repeat the parameter once per value: add another row with the same key for each additional value.", "disabled": true }, { "key": "pageIndex", "value": "", "description": "Not documented in the source specification. Optional, integer (int32).", "disabled": true }, { "key": "pageSize", "value": "", "description": "Maximum value is 50. Optional, integer (int32).", "disabled": true }, { "key": "createdAtEnd", "value": "", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "createdAtStart", "value": "", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "modifiedAtStart", "value": "", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "modifiedAtEnd", "value": "", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "name", "value": "", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "sortKey", "value": "", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "sortOrder", "value": "", "description": "Not documented in the source specification. Optional, string. Allowed values: `ASC`, `DESC`.", "disabled": true }, { "key": "isCreatedByMe", "value": "", "description": "Not documented in the source specification. Optional, boolean.", "disabled": true }, { "key": "isModifiedByMe", "value": "", "description": "Not documented in the source specification. Optional, boolean.", "disabled": true }, { "key": "templateId", "value": "", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "scriptEngine", "value": "", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "isValueNonNullable", "value": "", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "includeArchived", "value": "", "description": "Not documented in the source specification. Optional, boolean.", "disabled": true } ] }, "description": "Filters and lists email assets by the given criteria. Required Permissions: Read-Only Assets, Access Design Studio, Access Email.\n\nNote: The totalItems value in the response includes A/B test variants in its count; however, the A/B test variant emails themselves are not returned in the result.\n\n- **Endpoint:** `GET /rest/asset/v2/email/filter`\n- **Operation ID:** `filterContentUsingGET_email`\n- **API:** Asset API · Emails (New)\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [List Emails on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/emails-new/list-emails/)\n\n### Parameters\n\n- `access_token` · not sent; see notes · string · required — Token for Authorization.\n- `x-app-type` · header · string · required · Allowed values: `marketo`\n- `workspaceId` · query param · string · required\n- `folderId` · query param · string · optional\n- `folderType` · query param · string · optional · Allowed values: `Folder`, `Program`\n- `status` · query param · array of string · optional\n- `pageIndex` · query param · integer (int32) · optional\n- `pageSize` · query param · integer (int32) · optional\n- `createdAtEnd` · query param · string · optional\n- `createdAtStart` · query param · string · optional\n- `modifiedAtStart` · query param · string · optional\n- `modifiedAtEnd` · query param · string · optional\n- `name` · query param · string · optional\n- `sortKey` · query param · string · optional\n- `sortOrder` · query param · string · optional · Allowed values: `ASC`, `DESC`\n- `isCreatedByMe` · query param · boolean · optional\n- `isModifiedByMe` · query param · boolean · optional\n- `templateId` · query param · string · optional\n- `scriptEngine` · query param · string · optional\n- `isValueNonNullable` · query param · string · optional\n- `includeArchived` · query param · boolean · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [EmailFilterResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/emailfilterresponse/)\n- `default` — Error · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/errorresponse/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n- `pageIndex`: Not documented in the source specification.\n- `pageSize`: Maximum value is 50.\n\nThe source specification does not describe `pageIndex`, so this collection does not say whether it counts records or pages. See the [reference page](https://mkto-ref.harrisonjennings.au/reference/asset/emails-new/list-emails/), and send each page as a separate request.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value.\n\n### Notes\n\n- The source specification also lists an `access_token` query parameter. This collection sends the token in the `Authorization` header instead, so it is never added to URLs." } }, { "id": "26efae5c-ea63-5a82-9401-114e34aaf716", "name": "POST · Update Email Status", "request": { "method": "POST", "header": [ { "key": "x-app-type", "value": "marketo", "type": "text", "description": "Application type header. Required, string. Allowed values: `marketo`." } ], "body": { "mode": "raw", "raw": "{\n \"contentId\": null,\n \"action\": null\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v2/email/state/transition", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v2", "email", "state", "transition" ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nPerforms a state transition on an email. Required Permissions: Read-Write Assets, Access Design Studio, Approve Email.\n\n- **Endpoint:** `POST /rest/asset/v2/email/state/transition`\n- **Operation ID:** `stateTransitionUsingPOST_email`\n- **API:** Asset API · Emails (New)\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Email Status on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/emails-new/update-email-status/)\n\n### Parameters\n\n- `access_token` · not sent; see notes · string · required — Token for Authorization.\n- `x-app-type` · header · string · required · Allowed values: `marketo`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [StateTransitionRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/statetransitionrequest/)\n\nThe body starts with the required properties only, set to `null`. Replace each `null` with a value, and add any optional properties you need.\n\n**Properties**\n\n- `contentId` · string · required — Not documented in the source specification.\n- `action` · string · required — The state transition action to perform on the asset. Allowed values: `approve`, `unapprove`, `discard`, `create_draft`.\n\n### Responses\n\n- `200` — OK · [EmailNewResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/emailnewresponse/)\n- `default` — Error · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/errorresponse/)\n\nDeclared response media type: `application/json`.\n\n### Notes\n\n- The source specification also lists an `access_token` query parameter. This collection sends the token in the `Authorization` header instead, so it is never added to URLs." } }, { "id": "467dcce9-dae2-5c5f-9d06-cf21fb587b8f", "name": "POST · Get Email Used By", "request": { "method": "POST", "header": [ { "key": "x-app-type", "value": "marketo", "type": "text", "description": "Application type header. Required, string. Allowed values: `marketo`." } ], "body": { "mode": "raw", "raw": "{\n \"assetId\": null\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v2/email/usedby", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v2", "email", "usedby" ] }, "description": "Returns a list of assets that reference the specified email. Required Permissions: Read-Only Assets, Access Design Studio.\n\n- **Endpoint:** `POST /rest/asset/v2/email/usedby`\n- **Operation ID:** `getContentUsedByUsingPOST_email`\n- **API:** Asset API · Emails (New)\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Email Used By on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/emails-new/get-email-used-by/)\n\n### Parameters\n\n- `access_token` · not sent; see notes · string · required — Token for Authorization.\n- `x-app-type` · header · string · required · Allowed values: `marketo`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [UsedByRequestDto](https://mkto-ref.harrisonjennings.au/reference/asset/models/usedbyrequestdto/)\n\nThe body starts with the required properties only, set to `null`. Replace each `null` with a value, and add any optional properties you need.\n\n**Properties**\n\n- `assetId` · string · required — Not documented in the source specification.\n- `pageIndex` · integer (int32) · optional — Not documented in the source specification.\n- `pageSize` · integer (int32) · optional — Not documented in the source specification.\n- `type` · string · optional — Not documented in the source specification.\n\n### Responses\n\n- `200` — OK · [UsedByResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/usedbyresponse/)\n- `default` — Error · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/errorresponse/)\n\nDeclared response media type: `application/json`.\n\n### Notes\n\n- The source specification also lists an `access_token` query parameter. This collection sends the token in the `Authorization` header instead, so it is never added to URLs." } }, { "id": "7487642f-d728-5d85-b918-ebcfa6bd6345", "name": "GET · Get Email by Id", "request": { "method": "GET", "header": [ { "key": "x-app-type", "value": "marketo", "type": "text", "description": "Application type header. Required, string. Allowed values: `marketo`." } ], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v2/email/:id", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v2", "email", ":id" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, string." } ] }, "description": "Retrieves an email asset by its ID. Required Permissions: Read-Only Assets, Access Design Studio, Access Email.\n\n- **Endpoint:** `GET /rest/asset/v2/email/{id}`\n- **Operation ID:** `getContentUsingGET_email`\n- **API:** Asset API · Emails (New)\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Email by Id on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/emails-new/get-email-by-id/)\n\n### Parameters\n\n- `access_token` · not sent; see notes · string · required — Token for Authorization.\n- `x-app-type` · header · string · required · Allowed values: `marketo`\n- `id` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [EmailNewResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/emailnewresponse/)\n- `default` — Error · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/errorresponse/)\n\nDeclared response media type: `application/json`.\n\n### Notes\n\n- The source specification also lists an `access_token` query parameter. This collection sends the token in the `Authorization` header instead, so it is never added to URLs." } }, { "id": "f49c0f9c-48f4-590f-a1b1-c457d22637de", "name": "POST · Delete Email", "request": { "method": "POST", "header": [ { "key": "x-app-type", "value": "marketo", "type": "text", "description": "Application type header. Required, string. Allowed values: `marketo`." } ], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v2/email/:id/delete", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v2", "email", ":id", "delete" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, string." } ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDeletes an email asset by its ID. Required Permissions: Read-Write Assets, Access Design Studio, Delete Email.\n\n- **Endpoint:** `POST /rest/asset/v2/email/{id}/delete`\n- **Operation ID:** `deleteContentUsingPOST_email`\n- **API:** Asset API · Emails (New)\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete Email on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/emails-new/delete-email/)\n\n### Parameters\n\n- `access_token` · not sent; see notes · string · required — Token for Authorization.\n- `x-app-type` · header · string · required · Allowed values: `marketo`\n- `id` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [DeleteResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/deleteresponse/)\n- `default` — Error · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/errorresponse/)\n\nDeclared response media type: `application/json`.\n\n### Notes\n\n- The source specification also lists an `access_token` query parameter. This collection sends the token in the `Authorization` header instead, so it is never added to URLs." } }, { "id": "346d0e7d-c427-5bcf-8d19-13cf083f9267", "name": "POST · Update Email", "request": { "method": "POST", "header": [ { "key": "x-app-type", "value": "marketo", "type": "text", "description": "Application type header. Required, string. Allowed values: `marketo`." } ], "body": { "mode": "raw", "raw": "{}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v2/email/:id/update", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v2", "email", ":id", "update" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, string." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdates an existing email asset. Required Permissions: Read-Write Assets, Access Design Studio, Edit Email.\n\n- **Endpoint:** `POST /rest/asset/v2/email/{id}/update`\n- **Operation ID:** `updateContentUsingPOST_email`\n- **API:** Asset API · Emails (New)\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Email on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/emails-new/update-email/)\n\n### Parameters\n\n- `access_token` · not sent; see notes · string · required — Token for Authorization.\n- `x-app-type` · header · string · required · Allowed values: `marketo`\n- `id` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · optional · model [UpdateEmailRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/updateemailrequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `name` · string · optional — Not documented in the source specification.\n- `description` · string · optional — Not documented in the source specification.\n- `data` · DataDTO · optional — Not documented in the source specification.\n- `data.html` · HtmlDataDTO · optional — Not documented in the source specification.\n- `data.html.body` · string · optional — Not documented in the source specification.\n- `data.text` · TextDataDTO · optional — Not documented in the source specification.\n- `data.text.body` · string · optional — Not documented in the source specification.\n- `data.text.syncFromHtml` · boolean · optional — Not documented in the source specification.\n- `headers` · UpdateEmailHeadersDTO · optional — Not documented in the source specification.\n- `headers.ccEmails` · array of string · optional — Not documented in the source specification.\n- `headers.fromEmail` · string · optional — Not documented in the source specification.\n- `headers.fromName` · string · optional — Not documented in the source specification.\n- `headers.preheader` · string · optional — Not documented in the source specification.\n- `headers.replyEmail` · string · optional — Not documented in the source specification.\n- `headers.subject` · string · optional — Not documented in the source specification.\n- `editorContext` · EditorContextDto · optional — Not documented in the source specification.\n- `editorContext.dynamicContent` · object · optional — Not documented in the source specification.\n- `settings` · EmailSettingsDTO · optional — Not documented in the source specification.\n- `settings.brandedDomain` · string · optional — Not documented in the source specification.\n- `settings.dedicatedIp` · string · optional — Not documented in the source specification.\n- `settings.enableUrlTracking` · boolean · optional — Not documented in the source specification.\n- `settings.isOperational` · boolean · optional — Not documented in the source specification.\n- `settings.isTextOnly` · boolean · optional — Not documented in the source specification.\n- `settings.isWebPageView` · boolean · optional — Not documented in the source specification.\n- `templateId` · string · optional — When provided, the template's content overwrites both the email's existing content and any data sent in the request.\n\n### Responses\n\n- `200` — OK · [EmailNewResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/emailnewresponse/)\n- `default` — Error · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/errorresponse/)\n\nDeclared response media type: `application/json`.\n\n### Notes\n\n- The source specification also lists an `access_token` query parameter. This collection sends the token in the `Authorization` header instead, so it is never added to URLs." } }, { "id": "f8783118-1b75-592d-9549-742c66e56a52", "name": "POST · Bulk Get Emails", "request": { "method": "POST", "header": [ { "key": "x-app-type", "value": "", "type": "text", "description": "Application type header. Required, string." } ], "body": { "mode": "raw", "raw": "{\n \"assetIds\": []\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v2/email/bulk/get", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v2", "email", "bulk", "get" ] }, "description": "Retrieves multiple email assets by their IDs in a single request; each asset is returned in full, including its content. Maximum 20 assets per request. Required Permissions: Read-Only Assets, Access Design Studio, Access Email.\n\n- **Endpoint:** `POST /rest/asset/v2/email/bulk/get`\n- **Operation ID:** `bulkGetUsingPOST_email`\n- **API:** Asset API · Emails (New)\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Bulk Get Emails on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/emails-new/bulk-get-emails/)\n\n### Parameters\n\n- `access_token` · not sent; see notes · string · required — Token for Authorization.\n- `x-app-type` · header · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [BulkGetRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/bulkgetrequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `assetIds` · array of string · required — Set of asset IDs to retrieve. Maximum 20 per request.\n\n### Responses\n\n- `200` — OK · [EmailNewResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/emailnewresponse/)\n- `default` — Error · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/errorresponse/)\n\nDeclared response media type: `application/json`.\n\n### Notes\n\n- The source specification also lists an `access_token` query parameter. This collection sends the token in the `Authorization` header instead, so it is never added to URLs." } }, { "id": "4facafcd-fbac-52ed-a6e4-43b09770e0da", "name": "POST · Bulk Delete Emails", "request": { "method": "POST", "header": [ { "key": "x-app-type", "value": "", "type": "text", "description": "Application type header. Required, string." } ], "body": { "mode": "raw", "raw": "{\n \"assetIds\": []\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v2/email/bulk/delete", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v2", "email", "bulk", "delete" ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDeletes multiple email assets by their IDs in a single request. Maximum 20 assets per request. Required Permissions: Read-Write Assets, Access Design Studio, Delete Email.\n\n- **Endpoint:** `POST /rest/asset/v2/email/bulk/delete`\n- **Operation ID:** `bulkDeleteUsingPOST_email`\n- **API:** Asset API · Emails (New)\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Bulk Delete Emails on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/emails-new/bulk-delete-emails/)\n\n### Parameters\n\n- `access_token` · not sent; see notes · string · required — Token for Authorization.\n- `x-app-type` · header · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [BulkDeleteRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/bulkdeleterequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `assetIds` · array of string · required — Set of asset IDs to delete. Maximum 20 per request.\n- `ignoreUsedBy` · boolean · optional — If true, deletes assets even if they are referenced by other assets.\n\n### Responses\n\n- `200` — OK · [DeleteResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/deleteresponse/)\n- `default` — Error · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/errorresponse/)\n\nDeclared response media type: `application/json`.\n\n### Notes\n\n- The source specification also lists an `access_token` query parameter. This collection sends the token in the `Authorization` header instead, so it is never added to URLs." } }, { "id": "1826bb02-15f8-5d53-bd20-2d015d7979f6", "name": "POST · Bulk Get Emails Used By", "request": { "method": "POST", "header": [ { "key": "x-app-type", "value": "", "type": "text", "description": "Application type header. Required, string." } ], "body": { "mode": "raw", "raw": "{\n \"assetIds\": []\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v2/email/bulk/usedby", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v2", "email", "bulk", "usedby" ] }, "description": "Returns, for each of the specified emails, whether it is used and the number of places it is used (count) — not the referencing assets themselves. Maximum 50 assets per request. Required Permissions: Read-Only Assets, Access Design Studio.\n\n- **Endpoint:** `POST /rest/asset/v2/email/bulk/usedby`\n- **Operation ID:** `bulkUsedByUsingPOST_email`\n- **API:** Asset API · Emails (New)\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Bulk Get Emails Used By on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/emails-new/bulk-get-emails-used-by/)\n\n### Parameters\n\n- `access_token` · not sent; see notes · string · required — Token for Authorization.\n- `x-app-type` · header · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [BulkUsedByRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/bulkusedbyrequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `assetIds` · array of string · required — Asset IDs to query. Maximum 50 per request.\n\n### Responses\n\n- `200` — OK · [BulkUsedByResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/bulkusedbyresponse/)\n- `default` — Error · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/errorresponse/)\n\nDeclared response media type: `application/json`.\n\n### Notes\n\n- The source specification also lists an `access_token` query parameter. This collection sends the token in the `Authorization` header instead, so it is never added to URLs." } } ] }, { "id": "760749c5-d8a6-5874-8e7f-9848a6511542", "name": "File Contents", "description": "File Contents operations in the Asset API. Reference: [File Contents](https://mkto-ref.harrisonjennings.au/reference/asset/file-contents/).", "item": [ { "id": "255e7b74-0614-50ac-8ed9-f9d1faa4abf6", "name": "POST · Update File Content", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "description": "Multipart file. Content of the file. Required, file. Select a file in the Body tab before sending." }, { "key": "id", "value": "", "type": "text", "description": "Id of the file. Required, integer (int32)." } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/file/:id/content.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "file", ":id", "content.json" ], "variable": [ { "key": "id", "value": "", "description": "Id for file in database. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nReplaces the current content of the file with the included payload. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/file/{id}/content.json`\n- **Operation ID:** `updateContentUsingPOST`\n- **API:** Asset API · File Contents\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update File Content on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/file-contents/update-file-content/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`multipart/form-data` · required · model [UpdateFileContentRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/updatefilecontentrequest/)\n\nEach form field is a row in the **Body** tab (form-data), with its description. Required fields are enabled; optional fields are disabled until you enable them. File fields have no file selected.\n\n### Responses\n\n- `200` — OK · [ResponseOfFileResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoffileresponse/)\n\nDeclared response media type: `application/json`." } } ] }, { "id": "e08c8b9a-c6e4-580b-8e40-2e1010352600", "name": "Files", "description": "Files operations in the Asset API. Reference: [Files](https://mkto-ref.harrisonjennings.au/reference/asset/files/).", "item": [ { "id": "381dc2c8-57f2-5458-af98-62a69a25adfe", "name": "GET · Get File by Name", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/file/byName.json?name=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "file", "byName.json" ], "query": [ { "key": "name", "value": "", "description": "Name of the file. Required, string." } ] }, "description": "Returns files records for the given name. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/file/byName.json`\n- **Operation ID:** `getFileByNameUsingGET`\n- **API:** Asset API · Files\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get File by Name on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/files/get-file-by-name/)\n\n### Parameters\n\n- `name` · query param · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfFileResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoffileresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "c8872e8e-f8c7-5196-9413-49988f7aabd6", "name": "GET · Get File by Id", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/file/:id.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "file", ":id.json" ], "variable": [ { "key": "id", "value": "", "description": "Id for file in database. Required, integer (int32)." } ] }, "description": "Returns the file record for the given id. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/file/{id}.json`\n- **Operation ID:** `getFileByIdUsingGET`\n- **API:** Asset API · Files\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get File by Id on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/files/get-file-by-id/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfFileResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoffileresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "d4ef60db-73b2-58c8-aba8-23fdfc335c21", "name": "GET · Get Files", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/files.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "files.json" ], "query": [ { "key": "folder", "value": "", "description": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'. Optional, string.", "disabled": true }, { "key": "offset", "value": "", "description": "Integer offset for paging. Default 0. Optional, integer (int32).", "disabled": true }, { "key": "maxReturn", "value": "", "description": "Maximum number of files to return. Max 200, default 20. Optional, integer (int32).", "disabled": true } ] }, "description": "Returns the files from the given folder. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/files.json`\n- **Operation ID:** `getFilesUsingGET`\n- **API:** Asset API · Files\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Files on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/files/get-files/)\n\n### Parameters\n\n- `folder` · query param · string · optional\n- `offset` · query param · integer (int32) · optional\n- `maxReturn` · query param · integer (int32) · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfFileResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoffileresponse/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n- `offset`: Integer offset for paging. Default 0.\n- `maxReturn`: Maximum number of files to return. Max 200, default 20.\n\nAdobe's [Asset API documentation](https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/assets/assets) describes `offset` as the position at which to begin returning results, not a page number. To get the next page, add the `maxReturn` value you used to `offset` and send the request again.\n\nContinue until a response returns no more records. The source specification does not say that a page with fewer than `maxReturn` records is the last one.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "e2a261db-6925-5c27-8a65-fbef0cae1306", "name": "POST · Create File", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "description", "value": "", "type": "text", "description": "Description of the asset. Optional, string.", "disabled": true }, { "key": "file", "type": "file", "description": "Multipart file. Content of the file. Required, file. Select a file in the Body tab before sending." }, { "key": "folder", "value": "", "type": "text", "description": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'. Required, Folder. Send the value as JSON text; its properties are listed in the request description." }, { "key": "insertOnly", "value": "", "type": "text", "description": "Whether the calls hould fail if there is already an existing file with the same name. Optional, boolean.", "disabled": true }, { "key": "name", "value": "", "type": "text", "description": "Name of the File. Required, string." } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/files.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "files.json" ] }, "description": "> **Changes data.** Sending this request creates data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nCreates a new file from the included payload. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/files.json`\n- **Operation ID:** `createFileUsingPOST`\n- **API:** Asset API · Files\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Create File on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/files/create-file/)\n\n### Request body\n\n`multipart/form-data` · required · model [CreateFileRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/createfilerequest/)\n\nEach form field is a row in the **Body** tab (form-data), with its description. Required fields are enabled; optional fields are disabled until you enable them. File fields have no file selected.\n\n**Properties of JSON-valued fields**\n\n- `folder.id` · integer (int32) · required — Id of the folder.\n- `folder.type` · string · required — Type of folder. Allowed values: `Folder`, `Program`.\n\n### Responses\n\n- `200` — OK · [ResponseOfFileResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoffileresponse/)\n\nDeclared response media type: `application/json`." } } ] }, { "id": "50a745d6-c097-5b4f-a041-9dc0f8e0cfa2", "name": "Folders", "description": "Folders operations in the Asset API. Reference: [Folders](https://mkto-ref.harrisonjennings.au/reference/asset/folders/).", "item": [ { "id": "0b738262-4ff6-53b9-9a72-9c8f25df9c81", "name": "GET · Get Folder by Name", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/folder/byName.json?name=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "folder", "byName.json" ], "query": [ { "key": "name", "value": "", "description": "Name of the folder. Not applicable for Programs. Required, string." }, { "key": "type", "value": "", "description": "Type of folder. 'Folder' or 'Program'. Optional, string.", "disabled": true }, { "key": "root", "value": "", "description": "Parent folder reference. Optional, string.", "disabled": true }, { "key": "workSpace", "value": "", "description": "Name of the workspace. Optional, string.", "disabled": true } ] }, "description": "Returns a folder record for the given name. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/folder/byName.json`\n- **Operation ID:** `getFolderByNameUsingGET`\n- **API:** Asset API · Folders\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Folder by Name on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/folders/get-folder-by-name/)\n\n### Parameters\n\n- `name` · query param · string · required\n- `type` · query param · string · optional\n- `root` · query param · string · optional\n- `workSpace` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfFolderResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoffolderresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "4e75e3ed-99f2-5946-aaca-1432fc69719f", "name": "GET · Get Folder by Id", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/folder/:id.json?type=Folder", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "folder", ":id.json" ], "query": [ { "key": "type", "value": "Folder", "description": "Type of folder. 'Folder' or 'Program'. Required, string. Allowed values: `Folder`, `Program`. Default: `Folder`." } ], "variable": [ { "key": "id", "value": "", "description": "Id of the folder to retrieve. Required, integer (int32)." } ] }, "description": "Returns the folder record with the given id. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/folder/{id}.json`\n- **Operation ID:** `getFolderByIdUsingGET`\n- **API:** Asset API · Folders\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Folder by Id on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/folders/get-folder-by-id/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `type` · query param · string · required · Allowed values: `Folder`, `Program` · Default: `Folder`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfFolderResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoffolderresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "78014b28-bdd5-5cb4-a1fc-7eec9d11fd7b", "name": "POST · Update Folder Metadata", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "description", "value": "", "type": "text", "description": "Description of the asset. Optional, string.", "disabled": true }, { "key": "isArchive", "value": "", "type": "text", "description": "Whether the folder is archived or not. Toggling this value will change the archival status of the folder. Optional, boolean.", "disabled": true }, { "key": "name", "value": "", "type": "text", "description": "Name of the Folder. Optional, string.", "disabled": true }, { "key": "type", "value": "", "type": "text", "description": "Type of folder. 'Folder' or 'Program'. Required, string. Allowed values: `Folder`, `Program`." } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/folder/:id.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "folder", ":id.json" ], "variable": [ { "key": "id", "value": "", "description": "Id of the folder to update. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdates the metadata for a given folder. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/folder/{id}.json`\n- **Operation ID:** `updateFolderUsingPOST`\n- **API:** Asset API · Folders\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Folder Metadata on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/folders/update-folder-metadata/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [UpdateFolderRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/updatefolderrequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n### Responses\n\n- `200` — OK · [ResponseOfFolderResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoffolderresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "45c7ca17-486d-569a-b7f5-6e6021f74efd", "name": "GET · Get Folder Contents", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/folder/:id/content.json?type=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "folder", ":id", "content.json" ], "query": [ { "key": "maxReturn", "value": "", "description": "Maximum number of records to return. Max 200, default 20. Optional, integer (int32).", "disabled": true }, { "key": "offset", "value": "", "description": "Integer offset for paging. Optional, integer (int32).", "disabled": true }, { "key": "type", "value": "", "description": "Type of folder. 'Folder' or 'Program'. Default is 'Folder'. Required, string. Allowed values: `Folder`, `Program`." } ], "variable": [ { "key": "id", "value": "", "description": "Id of the folder to retrieve. Required, integer (int32)." } ] }, "description": "Returns records for the contents of a given folder. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/folder/{id}/content.json`\n- **Operation ID:** `getFolderContentUsingGET`\n- **API:** Asset API · Folders\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Folder Contents on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/folders/get-folder-contents/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `maxReturn` · query param · integer (int32) · optional\n- `offset` · query param · integer (int32) · optional\n- `type` · query param · string · required · Allowed values: `Folder`, `Program`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfFolderContentResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoffoldercontentresponse/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n- `offset`: Integer offset for paging.\n- `maxReturn`: Maximum number of records to return. Max 200, default 20.\n\nAdobe's [Asset API documentation](https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/assets/assets) describes `offset` as the position at which to begin returning results, not a page number. To get the next page, add the `maxReturn` value you used to `offset` and send the request again.\n\nContinue until a response returns no more records. The source specification does not say that a page with fewer than `maxReturn` records is the last one.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "a4a52eda-b89a-53bd-abbc-657e0b57d121", "name": "POST · Delete Folder", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "type", "value": "Folder", "type": "text", "description": "type. Required, string. Allowed values: `Program`, `Folder`. Default: `Folder`." } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/folder/:id/delete.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "folder", ":id", "delete.json" ], "variable": [ { "key": "id", "value": "", "description": "Id of the folder to delete. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDeletes the designated folder. Deletion will fail if the folder has content. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/folder/{id}/delete.json`\n- **Operation ID:** `deleteFolderUsingPOST`\n- **API:** Asset API · Folders\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete Folder on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/folders/delete-folder/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "fb89dcc8-2b49-57d2-b775-b65504b8c768", "name": "GET · Get Folders", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/folders.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "folders.json" ], "query": [ { "key": "root", "value": "", "description": "Parent folder reference. Optional, string.", "disabled": true }, { "key": "maxDepth", "value": "", "description": "Maximum folder depth to traverse, Default 2. Optional, integer (int32).", "disabled": true }, { "key": "maxReturn", "value": "", "description": "Maximum number of folders to return. Default 20, maximum 200. Optional, integer (int32).", "disabled": true }, { "key": "offset", "value": "", "description": "Integer offset for paging. Default 0. Optional, integer (int32).", "disabled": true }, { "key": "workSpace", "value": "", "description": "Name of the workspace. Optional, string.", "disabled": true } ] }, "description": "Retrieves child folders from within a given root folder. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/folders.json`\n- **Operation ID:** `getFolderUsingGET`\n- **API:** Asset API · Folders\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Folders on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/folders/get-folders/)\n\n### Parameters\n\n- `root` · query param · string · optional\n- `maxDepth` · query param · integer (int32) · optional\n- `maxReturn` · query param · integer (int32) · optional\n- `offset` · query param · integer (int32) · optional\n- `workSpace` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfFolderResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoffolderresponse/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n- `offset`: Integer offset for paging. Default 0.\n- `maxReturn`: Maximum number of folders to return. Default 20, maximum 200.\n\nAdobe's [Asset API documentation](https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/assets/assets) describes `offset` as the position at which to begin returning results, not a page number. To get the next page, add the `maxReturn` value you used to `offset` and send the request again.\n\nContinue until a response returns no more records. The source specification does not say that a page with fewer than `maxReturn` records is the last one.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "b028dcd0-fb43-58b6-ae6e-bf802f48d627", "name": "POST · Create Folder", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "description", "value": "", "type": "text", "description": "Description of the asset. Optional, string.", "disabled": true }, { "key": "name", "value": "", "type": "text", "description": "Name of the Folder. Required, string." }, { "key": "parent", "value": "", "type": "text", "description": "Folder object describing the parent folder. Required, Folder. Send the value as JSON text; its properties are listed in the request description." } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/folders.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "folders.json" ] }, "description": "> **Changes data.** Sending this request creates data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nCreates a new folder. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/folders.json`\n- **Operation ID:** `createFolderUsingPOST`\n- **API:** Asset API · Folders\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Create Folder on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/folders/create-folder/)\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [CreateFolderRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/createfolderrequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n**Properties of JSON-valued fields**\n\n- `parent.id` · integer (int32) · required — Id of the folder.\n- `parent.type` · string · required — Type of folder. Allowed values: `Folder`, `Program`.\n\n### Responses\n\n- `200` — OK · [ResponseOfFolderResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoffolderresponse/)\n\nDeclared response media type: `application/json`." } } ] }, { "id": "977b582c-bf09-5941-806b-9f9501255792", "name": "Form Fields", "description": "Form Fields operations in the Asset API. Reference: [Form Fields](https://mkto-ref.harrisonjennings.au/reference/asset/form-fields/).", "item": [ { "id": "4d00ee1a-13c8-512c-86c9-9642db8ddbb9", "name": "GET · Get Available Form Fields", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/form/fields.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "form", "fields.json" ], "query": [ { "key": "maxReturn", "value": "", "description": "Maximum number of fields to return. Max 200, default 20. Optional, integer (int32).", "disabled": true }, { "key": "offset", "value": "", "description": "Integer offset for paging. Optional, integer (int32).", "disabled": true } ] }, "description": "Retrieves a list of all valid fields for use in forms. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/form/fields.json`\n- **Operation ID:** `getAllFieldsUsingGET`\n- **API:** Asset API · Form Fields\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Available Form Fields on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/form-fields/get-available-form-fields/)\n\n### Parameters\n\n- `maxReturn` · query param · integer (int32) · optional\n- `offset` · query param · integer (int32) · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfFieldsMetaDataResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoffieldsmetadataresponse/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n- `offset`: Integer offset for paging.\n- `maxReturn`: Maximum number of fields to return. Max 200, default 20.\n\nAdobe's [Asset API documentation](https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/assets/assets) describes `offset` as the position at which to begin returning results, not a page number. To get the next page, add the `maxReturn` value you used to `offset` and send the request again.\n\nContinue until a response returns no more records. The source specification does not say that a page with fewer than `maxReturn` records is the last one.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "0af94fad-262c-5676-9066-72f510199819", "name": "GET · Get Available Form Program Member Fields", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/form/programMemberFields.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "form", "programMemberFields.json" ], "query": [ { "key": "maxReturn", "value": "", "description": "Maximum number of fields to return. Max 200, default 20. Optional, integer (int32).", "disabled": true }, { "key": "offset", "value": "", "description": "Integer offset for paging. Optional, integer (int32).", "disabled": true } ] }, "description": "Retrieves a list of all valid Program Member fields for use in forms. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/form/programMemberFields.json`\n- **Operation ID:** `getAllProgramMemberFieldsUsingGET`\n- **API:** Asset API · Form Fields\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Available Form Program Member Fields on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/form-fields/get-available-form-program-member-fields/)\n\n### Parameters\n\n- `maxReturn` · query param · integer (int32) · optional\n- `offset` · query param · integer (int32) · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfFieldsMetaDataResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoffieldsmetadataresponse/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n- `offset`: Integer offset for paging.\n- `maxReturn`: Maximum number of fields to return. Max 200, default 20.\n\nAdobe's [Asset API documentation](https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/assets/assets) describes `offset` as the position at which to begin returning results, not a page number. To get the next page, add the `maxReturn` value you used to `offset` and send the request again.\n\nContinue until a response returns no more records. The source specification does not say that a page with fewer than `maxReturn` records is the last one.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "e4a18f9a-f982-5937-87a7-a01127dc6e8a", "name": "POST · Add Form Field Visibility Rules", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "visibilityRule", "value": "", "type": "text", "description": "Not documented in the source specification. Optional, FormFieldVisibilityRequest. Send the value as JSON text; its properties are listed in the request description.", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/form/:formId/field/:fieldId/visibility.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "form", ":formId", "field", ":fieldId", "visibility.json" ], "variable": [ { "key": "formId", "value": "", "description": "formId. Required, integer (int32)." }, { "key": "fieldId", "value": "", "description": "fieldId. Required, string." } ] }, "description": "> **Changes data.** Sending this request adds records or associations in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nAdds a visibility rule to the target form field. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/form/{formId}/field/{fieldId}/visibility.json`\n- **Operation ID:** `addFormFieldVisibilityRuleUsingPOST`\n- **API:** Asset API · Form Fields\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Add Form Field Visibility Rules on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/form-fields/add-form-field-visibility-rules/)\n\n### Parameters\n\n- `formId` · path variable · integer (int32) · required\n- `fieldId` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [AddFormFieldVisibilityRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/addformfieldvisibilityrequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n**Properties of JSON-valued fields**\n\n- `visibilityRule.ruleType` · string · required — Type of rule to apply. Allowed values: `show`, `alwaysShow`, `hide`.\n- `visibilityRule.rules` · array of VisibilityRuleRequest · required — JSON Array of rules.\n- `visibilityRule.rules[].altLabel` · string · optional — Not documented in the source specification.\n- `visibilityRule.rules[].operator` · string · required — Operation to apply to target field. Evaluated against the list of values when applicable. Allowed values: `is`, `isNot`, `isEmpty`, `isNotEmpty`, `startsWith`, `notStartsWith`, `endsWith`, `notEndsWith`, `contains`, `notContains`, `greaterThan`, `lessThan`, `atLeast`, `atMost`, `between`, `notBetween`, `notInTimeFrame`, `inPast`, `notInPast`, `after`, `before`, `inTimeFrame`, `onOrAfter`, `onOrBefore`.\n- `visibilityRule.rules[].pickListValues` · array of PickListDTO · optional — Alternative label to display when rules are applied.\n- `visibilityRule.rules[].pickListValues[].isDefault` · boolean · optional — Not documented in the source specification.\n- `visibilityRule.rules[].pickListValues[].label` · string · optional — Not documented in the source specification.\n- `visibilityRule.rules[].pickListValues[].selected` · boolean · optional — Not documented in the source specification.\n- `visibilityRule.rules[].pickListValues[].value` · string · optional — Not documented in the source specification.\n- `visibilityRule.rules[].subjectField` · string · required — Target field id to apply the operation defined by operator to.\n- `visibilityRule.rules[].values` · array of string · required — Comma-separated list of values to match against. Valid for operators 'is', 'isNot', 'startsWith', 'notStartsWith', 'endsWith', 'notEndsWith', 'contains', and 'notContains'.\n\n### Responses\n\n- `200` — OK · [ResponseOfFormVisibilityRuleResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofformvisibilityruleresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "f9a8ae2e-e370-5e75-aa1d-b644b5d4469f", "name": "POST · Update Form Field", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "blankFields", "value": "", "type": "text", "description": "Number of blank fields to show when progressive profiling is enabled. Optional, integer (int32).", "disabled": true }, { "key": "defaultValue", "value": "", "type": "text", "description": "Optional default value for the field. Optional, string.", "disabled": true }, { "key": "fieldType", "value": "", "type": "text", "description": "Type of field. Optional, string.", "disabled": true }, { "key": "fieldWidth", "value": "", "type": "text", "description": "Width of the input or select element. Optional, integer (int32).", "disabled": true }, { "key": "formPrefill", "value": "", "type": "text", "description": "Whether the field should prefill. Default true. Optional, boolean.", "disabled": true }, { "key": "isSensitive", "value": "", "type": "text", "description": "Whether the field is marked as sensitive. Default false. Optional, boolean.", "disabled": true }, { "key": "hintText", "value": "", "type": "text", "description": "Hint text for the field. Optional, string.", "disabled": true }, { "key": "initiallyChecked", "value": "", "type": "text", "description": "Whether the field should be checked upon loading. Default false. Optional, boolean.", "disabled": true }, { "key": "instructions", "value": "", "type": "text", "description": "Instructions for the field. Optional, string.", "disabled": true }, { "key": "label", "value": "", "type": "text", "description": "Label of the field. Optional, string.", "disabled": true }, { "key": "labelToRight", "value": "", "type": "text", "description": "Whether the field label should be displayed to the right of the input/select element. Default false. Optional, boolean.", "disabled": true }, { "key": "labelWidth", "value": "", "type": "text", "description": "Width of the field label element. Optional, integer (int32).", "disabled": true }, { "key": "maskInput", "value": "", "type": "text", "description": "Optional input mask for the field. Optional, string.", "disabled": true }, { "key": "maxLength", "value": "", "type": "text", "description": "Maximum length for text type fields. Optional, integer (int32).", "disabled": true }, { "key": "maxValue", "value": "", "type": "text", "description": "Maximum value accepted by the field. Optional, number (float).", "disabled": true }, { "key": "minValue", "value": "", "type": "text", "description": "Minimum value accepted by the field. Optional, number (float).", "disabled": true }, { "key": "multiSelect", "value": "", "type": "text", "description": "Whether the field should allow multiple selections. Default false. Optional, boolean.", "disabled": true }, { "key": "required", "value": "", "type": "text", "description": "Whether the field is required to submit the form. Default false. Optional, boolean.", "disabled": true }, { "key": "validationMessage", "value": "", "type": "text", "description": "Validation message to display on failed validation. Optional, string.", "disabled": true }, { "key": "values", "value": "", "type": "text", "description": "Array of JSON objects that contain field attributes. Only for select-field types. Example: values=[{'label':'Select...','value':'','isDefault':true,'selected':true}, {'label':'MR','value':'Mr'}, {'label':'MS','value':'Ms'}, {'label':'MRS','value':'Mrs'}, {'label':'DR','value':'Dr'}, {'label':'PROF','value':'Prof'}]. Optional, string.", "disabled": true }, { "key": "visibleLines", "value": "", "type": "text", "description": "Number of lines to display for the field element. Optional, integer (int32).", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/form/:id/field/:fieldId.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "form", ":id", "field", ":fieldId.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." }, { "key": "fieldId", "value": "", "description": "fieldId. Required, string." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdates the configuration for that target field. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/form/{id}/field/{fieldId}.json`\n- **Operation ID:** `updateFormFieldUsingPOST`\n- **API:** Asset API · Form Fields\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Form Field on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/form-fields/update-form-field/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `fieldId` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [UpdateFormFieldRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/updateformfieldrequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n### Responses\n\n- `200` — OK · [ResponseOfLpFormFieldResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflpformfieldresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "cab78404-5a28-5216-96a0-5c21e68c8728", "name": "POST · Delete Form Field", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/form/:id/field/:fieldId/delete.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "form", ":id", "field", ":fieldId", "delete.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." }, { "key": "fieldId", "value": "", "description": "fieldId. Required, string." } ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDeletes a field from a form. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/form/{id}/field/{fieldId}/delete.json`\n- **Operation ID:** `deleteFormFieldUsingPOST`\n- **API:** Asset API · Form Fields\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete Form Field on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/form-fields/delete-form-field/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `fieldId` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "60aade03-ab2f-535a-aea0-29b0667b448c", "name": "POST · Add Fieldset to Form", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "label", "value": "", "type": "text", "description": "Label of the fieldset. Required, string." } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/form/:id/fieldSet.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "form", ":id", "fieldSet.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request adds records or associations in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nAdds a field set to the target form. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/form/{id}/fieldSet.json`\n- **Operation ID:** `addFieldSetUsingPOST`\n- **API:** Asset API · Form Fields\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Add Fieldset to Form on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/form-fields/add-fieldset-to-form/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [AddFormFieldSetRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/addformfieldsetrequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n### Responses\n\n- `200` — OK · [ResponseOfLpFormFieldResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflpformfieldresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "edb526e4-ca2f-5602-bcce-786086eeab94", "name": "POST · Delete Field from Fieldset", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/form/:id/fieldSet/:fieldSetId/field/:fieldId/delete.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "form", ":id", "fieldSet", ":fieldSetId", "field", ":fieldId", "delete.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." }, { "key": "fieldSetId", "value": "", "description": "fieldSetId. Required, string." }, { "key": "fieldId", "value": "", "description": "fieldId. Required, string." } ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nRemoves the target field from the fieldset. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/form/{id}/fieldSet/{fieldSetId}/field/{fieldId}/delete.json`\n- **Operation ID:** `deleteFormFieldFromFieldSetUsingPOST`\n- **API:** Asset API · Form Fields\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete Field from Fieldset on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/form-fields/delete-field-from-fieldset/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `fieldSetId` · path variable · string · required\n- `fieldId` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "afc4fb59-00e1-5c71-8687-5d2e3490c1c6", "name": "GET · Get Fields for Form", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/form/:id/fields.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "form", ":id", "fields.json" ], "query": [ { "key": "status", "value": "", "description": "Status filter for draft or approved versions. Optional, string. Allowed values: `approved`, `draft`.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "Retrieves the list of fields in the target form. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/form/{id}/fields.json`\n- **Operation ID:** `getFormFieldByFormVidUsingGET`\n- **API:** Asset API · Form Fields\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Fields for Form on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/form-fields/get-fields-for-form/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `status` · query param · string · optional · Allowed values: `approved`, `draft`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLpFormFieldResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflpformfieldresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "9c3757f6-f633-58ec-ae1c-78a4f64518a0", "name": "POST · Add Field to Form", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "blankFields", "value": "", "type": "text", "description": "Number of blank fields to show when progressive profiling is enabled. Optional, integer (int32).", "disabled": true }, { "key": "defaultValue", "value": "", "type": "text", "description": "Optional default value for the field. Optional, string.", "disabled": true }, { "key": "fieldId", "value": "", "type": "text", "description": "Id of the field. Required, string." }, { "key": "fieldType", "value": "", "type": "text", "description": "Specifies the field type. Optional, string.", "disabled": true }, { "key": "fieldWidth", "value": "", "type": "text", "description": "Width of the input or select element. Optional, integer (int32).", "disabled": true }, { "key": "formPrefill", "value": "", "type": "text", "description": "Whether the field should prefill. Default true. Optional, boolean.", "disabled": true }, { "key": "isSensitive", "value": "", "type": "text", "description": "Whether the field is marked as sensitive. Default false. Optional, boolean.", "disabled": true }, { "key": "hintText", "value": "", "type": "text", "description": "Hint text for the field. Optional, string.", "disabled": true }, { "key": "initiallyChecked", "value": "", "type": "text", "description": "Whether the field should be checked upon loading. Default false. Optional, boolean.", "disabled": true }, { "key": "instructions", "value": "", "type": "text", "description": "Instructions for the field. Optional, string.", "disabled": true }, { "key": "label", "value": "", "type": "text", "description": "Label of the field. Optional, string.", "disabled": true }, { "key": "labelToRight", "value": "", "type": "text", "description": "Whether the field label should be displayed to the right of the input/select element. Default false. Optional, boolean.", "disabled": true }, { "key": "labelWidth", "value": "", "type": "text", "description": "Width of the field label element. Optional, integer (int32).", "disabled": true }, { "key": "maskInput", "value": "", "type": "text", "description": "Optional input mask for the field. Optional, string.", "disabled": true }, { "key": "maxLength", "value": "", "type": "text", "description": "Maximum length for text type fields. Optional, integer (int32).", "disabled": true }, { "key": "maxValue", "value": "", "type": "text", "description": "Maximum value accepted by the field. Optional, number (float).", "disabled": true }, { "key": "minValue", "value": "", "type": "text", "description": "Minimum value accepted by the field. Optional, number (float).", "disabled": true }, { "key": "multiSelect", "value": "", "type": "text", "description": "Whether the field should allow multiple selections. Default false. Optional, boolean.", "disabled": true }, { "key": "required", "value": "", "type": "text", "description": "Whether the field is required to submit the form. Default false. Optional, boolean.", "disabled": true }, { "key": "validationMessage", "value": "", "type": "text", "description": "Validation message to display on failed validation. Optional, string.", "disabled": true }, { "key": "values", "value": "", "type": "text", "description": "Comma-separated list of accepted values for the field. Only for select-field types. Optional, string.", "disabled": true }, { "key": "visibleLines", "value": "", "type": "text", "description": "Number of lines to display for the field element. Optional, integer (int32).", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/form/:id/fields.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "form", ":id", "fields.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request adds records or associations in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nAdds a field to a form. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/form/{id}/fields.json`\n- **Operation ID:** `addFieldToAFormUsingPOST`\n- **API:** Asset API · Form Fields\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Add Field to Form on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/form-fields/add-field-to-form/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [AddFormFieldRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/addformfieldrequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n### Responses\n\n- `200` — OK · [ResponseOfLpFormFieldResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflpformfieldresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "d2c51d0b-4163-5865-bab2-76c930189563", "name": "POST · Update Field Positions", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "positions", "value": "", "type": "text", "description": "Not documented in the source specification. Optional, array of UpdateFieldPosition. Send the value as JSON text; its properties are listed in the request description.", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/form/:id/reArrange.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "form", ":id", "reArrange.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nReorders the list of fields in a form. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/form/{id}/reArrange.json`\n- **Operation ID:** `updateFieldPositionsUsingPOST`\n- **API:** Asset API · Form Fields\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Field Positions on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/form-fields/update-field-positions/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · optional · model [ReArrangeRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/rearrangerequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n**Properties of JSON-valued fields**\n\n- `positions[].columnNumber` · integer (int32) · required — Column number of the field.\n- `positions[].fieldList` · array of UpdateFieldPosition · optional — List of positions inside the fields. Only valid if the target is a fieldset. Its properties are those of [UpdateFieldPosition](https://mkto-ref.harrisonjennings.au/reference/asset/models/updatefieldposition/), listed above.\n- `positions[].fieldName` · string · required — Id of the field.\n- `positions[].rowNumber` · integer (int32) · required — Row number of the field.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "0ca3541c-d3ba-522a-abec-579e7480afc7", "name": "POST · Add Rich Text Field", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "text", "value": "", "type": "text", "description": "Multipart file. HTML Content for the rich text field. Required, string." } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/form/:id/richText.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "form", ":id", "richText.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request adds records or associations in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nAdds a rich-text type field to the form. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/form/{id}/richText.json`\n- **Operation ID:** `addRichTextFieldUsingPOST`\n- **API:** Asset API · Form Fields\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Add Rich Text Field on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/form-fields/add-rich-text-field/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [AddRichTextRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/addrichtextrequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n### Responses\n\n- `200` — OK · [ResponseOfLpFormFieldResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflpformfieldresponse/)\n\nDeclared response media type: `application/json`." } } ] }, { "id": "545de9dd-2ed3-5cd2-afc2-2cfe39c563af", "name": "Forms", "description": "Forms operations in the Asset API. Reference: [Forms](https://mkto-ref.harrisonjennings.au/reference/asset/forms/).", "item": [ { "id": "90131acc-4ce0-51f1-b871-d19dfcdf5440", "name": "GET · Get Form by Name", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/form/byName.json?name=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "form", "byName.json" ], "query": [ { "key": "name", "value": "", "description": "Name of the form. Required, string." }, { "key": "status", "value": "", "description": "Status filter for draft or approved versions. Optional, string. Allowed values: `approved`, `draft`.", "disabled": true }, { "key": "folder", "value": "", "description": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'. Optional, string.", "disabled": true } ] }, "description": "Retrieves a form record by its name. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/form/byName.json`\n- **Operation ID:** `getLpFormByNameUsingGET`\n- **API:** Asset API · Forms\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Form by Name on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/forms/get-form-by-name/)\n\n### Parameters\n\n- `name` · query param · string · required\n- `status` · query param · string · optional · Allowed values: `approved`, `draft`\n- `folder` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLpFormResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflpformresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "a80d1d1f-2ab5-5aed-b759-f1d402c169fa", "name": "GET · Get Form By Id", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/form/:id.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "form", ":id.json" ], "query": [ { "key": "status", "value": "", "description": "Status filter for draft or approved versions. Optional, string. Allowed values: `approved`, `draft`.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "Retrieves a form record by its id. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/form/{id}.json`\n- **Operation ID:** `getLpFormByIdUsingGET`\n- **API:** Asset API · Forms\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Form By Id on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/forms/get-form-by-id/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `status` · query param · string · optional · Allowed values: `approved`, `draft`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLpFormResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflpformresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "b50ea9c0-65d2-5f8f-918d-7b3981cedc83", "name": "POST · Update Form Metadata", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "customCss", "value": "", "type": "text", "description": "Custom CSS to apply to the form. Optional, string.", "disabled": true }, { "key": "description", "value": "", "type": "text", "description": "Description of the form. Optional, string.", "disabled": true }, { "key": "fontFamily", "value": "", "type": "text", "description": "font-family property for the form. Optional, string.", "disabled": true }, { "key": "fontSize", "value": "", "type": "text", "description": "font-size property of the form. Optional, string.", "disabled": true }, { "key": "knownVisitor", "value": "", "type": "text", "description": "Known visitor behavior for the form. Optional, FormKnownVisitorDTO. Send the value as JSON text; its properties are listed in the request description.", "disabled": true }, { "key": "labelPosition", "value": "", "type": "text", "description": "Default positioning of labels. Optional, string.", "disabled": true }, { "key": "language", "value": "", "type": "text", "description": "Language of the form. Optional, string.", "disabled": true }, { "key": "locale", "value": "", "type": "text", "description": "Locale of the form. Optional, string.", "disabled": true }, { "key": "name", "value": "", "type": "text", "description": "Name of the form. Optional, string.", "disabled": true }, { "key": "progressiveProfiling", "value": "", "type": "text", "description": "Whether progressive profiling is enabled for the form. Optional, boolean.", "disabled": true }, { "key": "theme", "value": "", "type": "text", "description": "CSS theme for the form to use. Optional, string.", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/form/:id.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "form", ":id.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdates the metadata of the target form. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/form/{id}.json`\n- **Operation ID:** `updateFormsUsingPOST`\n- **API:** Asset API · Forms\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Form Metadata on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/forms/update-form-metadata/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [UpdateFormMetaDataRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/updateformmetadatarequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n**Properties of JSON-valued fields**\n\n- `knownVisitor.template` · string · optional — Not documented in the source specification.\n- `knownVisitor.type` · string · optional — Not documented in the source specification.\n\n### Responses\n\n- `200` — OK · [ResponseOfLpFormResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflpformresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "ed243f06-bee1-5050-a080-4210b2a2f6c8", "name": "POST · Approve Form Draft", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/form/:id/approveDraft.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "form", ":id", "approveDraft.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request approves an asset in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nApproves the current draft of the form. This will delete the current approved version of the form. Required Permissions: Approve Assets\n\n- **Endpoint:** `POST /rest/asset/v1/form/{id}/approveDraft.json`\n- **Operation ID:** `approveFromUsingPOST`\n- **API:** Asset API · Forms\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Approve Form Draft on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/forms/approve-form-draft/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLpFormResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflpformresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "8aec8cd0-3c7b-5acd-a766-f4572f520c36", "name": "POST · Clone Form", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "name", "value": "", "type": "text", "description": "Name for the cloned form. Required, string." }, { "key": "folder", "value": "", "type": "text", "description": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'. Required, Folder. Send the value as JSON text; its properties are listed in the request description." }, { "key": "description", "value": "", "type": "text", "description": "Description of the cloned form. Optional, string.", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/form/:id/clone.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "form", ":id", "clone.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request creates a copy of an asset in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nClones the target form. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/form/{id}/clone.json`\n- **Operation ID:** `cloneLpFormsUsingPOST`\n- **API:** Asset API · Forms\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Clone Form on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/forms/clone-form/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · optional · model [CloneFormRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/cloneformrequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n**Properties of JSON-valued fields**\n\n- `folder.id` · integer (int32) · required — Id of the folder.\n- `folder.type` · string · required — Type of folder. Allowed values: `Folder`, `Program`.\n\n### Responses\n\n- `200` — OK · [ResponseOfLpFormResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflpformresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "5f49b579-a1ba-5739-9bc9-a4d94f7f78f0", "name": "POST · Delete Form", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/form/:id/delete.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "form", ":id", "delete.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDeletes 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\n\n- **Endpoint:** `POST /rest/asset/v1/form/{id}/delete.json`\n- **Operation ID:** `deleteFormByIdUsingPOST`\n- **API:** Asset API · Forms\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete Form on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/forms/delete-form/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "c7108fb6-0781-5c6b-8ddd-d501a3084a87", "name": "POST · Discard Form Draft", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/form/:id/discardDraft.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "form", ":id", "discardDraft.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request discards a draft in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDiscards the current draft of the form. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/form/{id}/discardDraft.json`\n- **Operation ID:** `discardFormByIdUsingPOST`\n- **API:** Asset API · Forms\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Discard Form Draft on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/forms/discard-form-draft/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "71e3d5ff-2176-550b-af1f-136be66361ba", "name": "POST · Update Submit Button", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "buttonPosition", "value": "", "type": "text", "description": "Location in pixels of the button relative to the left of the form. Optional, integer (int32).", "disabled": true }, { "key": "buttonStyle", "value": "", "type": "text", "description": "Style of the button. Optional, string.", "disabled": true }, { "key": "label", "value": "", "type": "text", "description": "Label text of the button. Optional, string.", "disabled": true }, { "key": "waitingLabel", "value": "", "type": "text", "description": "Waiting text of the button. Optional, string.", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/form/:id/submitButton.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "form", ":id", "submitButton.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdates the submit button configuration for the target form. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/form/{id}/submitButton.json`\n- **Operation ID:** `updateFormSubmitButtonUsingPOST`\n- **API:** Asset API · Forms\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Submit Button on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/forms/update-submit-button/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [SubmitButtonRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/submitbuttonrequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n### Responses\n\n- `200` — OK · [ResponseOfLpFormResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflpformresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "fcdd2a72-8e5a-570e-b8e6-87eb692c0e17", "name": "GET · Get Thank You Page by Form Id", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/form/:id/thankYouPage.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "form", ":id", "thankYouPage.json" ], "query": [ { "key": "status", "value": "", "description": "Status filter for draft or approved versions. Optional, string. Allowed values: `approved`, `draft`.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "Returns the thank you page configuration for a given form. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/form/{id}/thankYouPage.json`\n- **Operation ID:** `getThankYouPageByIdUsingGET`\n- **API:** Asset API · Forms\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Thank You Page by Form Id on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/forms/get-thank-you-page-by-form-id/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `status` · query param · string · optional · Allowed values: `approved`, `draft`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfThankYouPageResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofthankyoupageresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "b8a5ba86-b3b6-5001-81b4-794ca1bdfad5", "name": "POST · Update Thank You Page", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "thankyou", "value": "", "type": "text", "description": "JSON array of followup rules. Optional, array of ThankYouPageRequest. Send the value as JSON text; its properties are listed in the request description.", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/form/:id/thankYouPage.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "form", ":id", "thankYouPage.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdates 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\n\n- **Endpoint:** `POST /rest/asset/v1/form/{id}/thankYouPage.json`\n- **Operation ID:** `updateThankYouPageByIdUsingPOST`\n- **API:** Asset API · Forms\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Thank You Page on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/forms/update-thank-you-page/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [UpdateThankYouPageRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/updatethankyoupagerequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n**Properties of JSON-valued fields**\n\n- `thankyou[].default` · boolean · optional — When true, this is the default rule, and will be applied when a user does not qualify for any of the other rules.\n- `thankyou[].followupType` · string · required — 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.\n- `thankyou[].followupValue` · string · required — Where to follow to on submission. Given as a URL or and Integer depending on followupType.\n- `thankyou[].operator` · string · required — Operator to evaluate aginst the subject field.\n- `thankyou[].subjectField` · string · required — Field to apply to operator to.\n- `thankyou[].values` · array of string · required — Comma-separated list of values to compare to with the operator.\n\n### Responses\n\n- `200` — OK · [ResponseOfThankYouPageResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofthankyoupageresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "ab98c96e-14dd-54d4-86e7-97367b090c1e", "name": "GET · Get Forms", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/forms.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "forms.json" ], "query": [ { "key": "status", "value": "", "description": "Status filter for draft or approved versions. Optional, string. Allowed values: `approved`, `draft`.", "disabled": true }, { "key": "folder", "value": "", "description": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'. Optional, string.", "disabled": true }, { "key": "maxReturn", "value": "", "description": "Maximum number of forms to return. Max 200, default 20. Optional, integer (int32).", "disabled": true }, { "key": "offset", "value": "", "description": "Integer offset for paging. Optional, string.", "disabled": true } ] }, "description": "Retrieves a list of accessible form records from the target instance. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/forms.json`\n- **Operation ID:** `browseForms2UsingGET`\n- **API:** Asset API · Forms\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Forms on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/forms/get-forms/)\n\n### Parameters\n\n- `status` · query param · string · optional · Allowed values: `approved`, `draft`\n- `folder` · query param · string · optional\n- `maxReturn` · query param · integer (int32) · optional\n- `offset` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLpFormResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflpformresponse/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n- `offset`: Integer offset for paging.\n- `maxReturn`: Maximum number of forms to return. Max 200, default 20.\n\nAdobe's [Asset API documentation](https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/assets/assets) describes `offset` as the position at which to begin returning results, not a page number. To get the next page, add the `maxReturn` value you used to `offset` and send the request again.\n\nContinue until a response returns no more records. The source specification does not say that a page with fewer than `maxReturn` records is the last one.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "b15e528a-4bdd-5268-b39e-091606df16bc", "name": "POST · Create Form", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "description", "value": "", "type": "text", "description": "Description of the form. Optional, string.", "disabled": true }, { "key": "folder", "value": "", "type": "text", "description": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'. Required, Folder. Send the value as JSON text; its properties are listed in the request description." }, { "key": "fontFamily", "value": "", "type": "text", "description": "font-family property for the form. Optional, string.", "disabled": true }, { "key": "fontSize", "value": "", "type": "text", "description": "font-size property of the form. Optional, string.", "disabled": true }, { "key": "knownVisitor", "value": "", "type": "text", "description": "Known visitor behavior for the form. Optional, FormKnownVisitorDTO. Send the value as JSON text; its properties are listed in the request description.", "disabled": true }, { "key": "labelPosition", "value": "", "type": "text", "description": "Default positioning of labels. Optional, string.", "disabled": true }, { "key": "language", "value": "", "type": "text", "description": "Language of the form. Optional, string.", "disabled": true }, { "key": "locale", "value": "", "type": "text", "description": "Locale of the form. Optional, string.", "disabled": true }, { "key": "name", "value": "", "type": "text", "description": "Name of the form. Optional, string.", "disabled": true }, { "key": "progressiveProfiling", "value": "", "type": "text", "description": "Whether progressive profiling is enabled for the form. Optional, boolean.", "disabled": true }, { "key": "theme", "value": "", "type": "text", "description": "CSS theme for the form to use. Optional, string.", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/forms.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "forms.json" ] }, "description": "> **Changes data.** Sending this request creates data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nCreates a new form. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/forms.json`\n- **Operation ID:** `createLpFormsUsingPOST`\n- **API:** Asset API · Forms\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Create Form on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/forms/create-form/)\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [CreateLpFormRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/createlpformrequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n**Properties of JSON-valued fields**\n\n- `folder.id` · integer (int32) · required — Id of the folder.\n- `folder.type` · string · required — Type of folder. Allowed values: `Folder`, `Program`.\n- `knownVisitor.template` · string · optional — Not documented in the source specification.\n- `knownVisitor.type` · string · optional — Not documented in the source specification.\n\n### Responses\n\n- `200` — OK · [ResponseOfLpFormResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflpformresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "c18badc7-2649-5a32-90c3-6617cf23f4d5", "name": "GET · Get Form Used By", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/form/:id/usedBy.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "form", ":id", "usedBy.json" ], "query": [ { "key": "offset", "value": "", "description": "Integer offset for paging. Optional, integer (int32).", "disabled": true }, { "key": "maxReturn", "value": "", "description": "Maximum number of assets to return. Max 200, default 20. Optional, integer (int32).", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "Id of the form. Required, integer (int32)." } ] }, "description": "Returns a list of asset records which depend on a given form. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/form/{id}/usedBy.json`\n- **Operation ID:** `getFormUsedByUsingGET`\n- **API:** Asset API · Forms\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Form Used By on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/forms/get-form-used-by/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `offset` · query param · integer (int32) · optional\n- `maxReturn` · query param · integer (int32) · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfFormUsedByResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofformusedbyresponse/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n- `offset`: Integer offset for paging.\n- `maxReturn`: Maximum number of assets to return. Max 200, default 20.\n\nAdobe's [Asset API documentation](https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/assets/assets) describes `offset` as the position at which to begin returning results, not a page number. To get the next page, add the `maxReturn` value you used to `offset` and send the request again.\n\nContinue until a response returns no more records. The source specification does not say that a page with fewer than `maxReturn` records is the last one.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } } ] }, { "id": "688dc9b7-5314-586a-ad79-91ae96a17beb", "name": "Fragments (New)", "description": "Fragments (New) operations in the Asset API. Reference: [Fragments (New)](https://mkto-ref.harrisonjennings.au/reference/asset/fragments-new/).", "item": [ { "id": "d8947403-49d1-508c-b605-2cf27ffe0dfe", "name": "POST · Create Fragment", "request": { "method": "POST", "header": [ { "key": "x-app-type", "value": "marketo", "type": "text", "description": "Application type header. Required, string. Allowed values: `marketo`." } ], "body": { "mode": "raw", "raw": "{\n \"name\": null,\n \"appData\": {},\n \"settings\": {\n \"fragmentType\": null,\n \"supportedChannels\": []\n }\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v2/fragment", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v2", "fragment" ] }, "description": "> **Changes data.** Sending this request creates data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nCreates a new fragment. Required Permissions: Read-Write Assets, Access Design Studio, Edit Snippet.\n\n- **Endpoint:** `POST /rest/asset/v2/fragment`\n- **Operation ID:** `createContentUsingPOST_fragment`\n- **API:** Asset API · Fragments (New)\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Create Fragment on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/fragments-new/create-fragment/)\n\n### Parameters\n\n- `access_token` · not sent; see notes · string · required — Token for Authorization.\n- `x-app-type` · header · string · required · Allowed values: `marketo`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [CreateFragmentRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/createfragmentrequest/)\n\nThe body starts with the required properties only, set to `null`. Replace each `null` with a value, and add any optional properties you need.\n\n**Properties**\n\n- `name` · string · required — Not documented in the source specification.\n- `description` · string · optional — Not documented in the source specification.\n- `appData` · AppDataDTO · required — Not documented in the source specification.\n- `appData.editorType` · string · optional — Not documented in the source specification.\n- `appData.folderId` · string · optional — Not documented in the source specification.\n- `appData.workspaceId` · string · optional — Not documented in the source specification.\n- `data` · DataDTO · optional — Not documented in the source specification.\n- `data.html` · HtmlDataDTO · optional — Not documented in the source specification.\n- `data.html.body` · string · optional — Not documented in the source specification.\n- `data.text` · TextDataDTO · optional — Not documented in the source specification.\n- `data.text.body` · string · optional — Not documented in the source specification.\n- `data.text.syncFromHtml` · boolean · optional — Not documented in the source specification.\n- `editorContext` · EditorContextDto · optional — Not documented in the source specification.\n- `editorContext.dynamicContent` · object · optional — Not documented in the source specification.\n- `settings` · FragmentSettingsDTO · required — Not documented in the source specification.\n- `settings.fragmentType` · string · required — Not documented in the source specification.\n- `settings.fragmentSubType` · string · optional — Not documented in the source specification.\n- `settings.supportedChannels` · array of string · required — Not documented in the source specification.\n\n### Responses\n\n- `200` — OK · [FragmentNewResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/fragmentnewresponse/)\n- `default` — Error · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/errorresponse/)\n\nDeclared response media type: `application/json`.\n\n### Notes\n\n- The source specification also lists an `access_token` query parameter. This collection sends the token in the `Authorization` header instead, so it is never added to URLs." } }, { "id": "7cbc8b9a-cff2-5bca-9ffd-fd10bf927613", "name": "POST · Clone Fragment", "request": { "method": "POST", "header": [ { "key": "x-app-type", "value": "marketo", "type": "text", "description": "Application type header. Required, string. Allowed values: `marketo`." } ], "body": { "mode": "raw", "raw": "{\n \"assetId\": null,\n \"newAsset\": {\n \"name\": null\n }\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v2/fragment/clone", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v2", "fragment", "clone" ] }, "description": "> **Changes data.** Sending this request creates a copy of an asset in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nClones an existing fragment. Required Permissions: Read-Write Assets, Access Design Studio, Edit Snippet.\n\n- **Endpoint:** `POST /rest/asset/v2/fragment/clone`\n- **Operation ID:** `cloneContentUsingPOST_fragment`\n- **API:** Asset API · Fragments (New)\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Clone Fragment on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/fragments-new/clone-fragment/)\n\n### Parameters\n\n- `access_token` · not sent; see notes · string · required — Token for Authorization.\n- `x-app-type` · header · string · required · Allowed values: `marketo`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [CloneAssetRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/cloneassetrequest/)\n\nThe body starts with the required properties only, set to `null`. Replace each `null` with a value, and add any optional properties you need.\n\n**Properties**\n\n- `assetId` · string · required — Not documented in the source specification.\n- `newAsset` · CloneNewAsset · required — Not documented in the source specification.\n- `newAsset.name` · string · required — Not documented in the source specification.\n- `newAsset.description` · string · optional — Not documented in the source specification.\n\n### Responses\n\n- `200` — OK · [FragmentNewResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/fragmentnewresponse/)\n- `default` — Error · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/errorresponse/)\n\nDeclared response media type: `application/json`.\n\n### Notes\n\n- The source specification also lists an `access_token` query parameter. This collection sends the token in the `Authorization` header instead, so it is never added to URLs." } }, { "id": "ac692b54-df0b-5c72-8b2f-efffcffc3771", "name": "GET · List Fragments", "request": { "method": "GET", "header": [ { "key": "x-app-type", "value": "marketo", "type": "text", "description": "Application type header. Required, string. Allowed values: `marketo`." } ], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v2/fragment/filter?workspaceId=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v2", "fragment", "filter" ], "query": [ { "key": "workspaceId", "value": "", "description": "Not documented in the source specification. Required, string." }, { "key": "folderId", "value": "", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "folderType", "value": "", "description": "Not documented in the source specification. Optional, string. Allowed values: `Folder`, `Program`.", "disabled": true }, { "key": "status", "value": "", "description": "Not documented in the source specification. Optional, array of string. Repeat the parameter once per value: add another row with the same key for each additional value.", "disabled": true }, { "key": "pageIndex", "value": "", "description": "Not documented in the source specification. Optional, integer (int32).", "disabled": true }, { "key": "pageSize", "value": "", "description": "Maximum value is 50. Optional, integer (int32).", "disabled": true }, { "key": "createdAtEnd", "value": "", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "createdAtStart", "value": "", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "modifiedAtStart", "value": "", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "modifiedAtEnd", "value": "", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "name", "value": "", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "fragmentType", "value": "", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "sortKey", "value": "", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "sortOrder", "value": "", "description": "Not documented in the source specification. Optional, string. Allowed values: `ASC`, `DESC`.", "disabled": true }, { "key": "isCreatedByMe", "value": "", "description": "Not documented in the source specification. Optional, boolean.", "disabled": true }, { "key": "isModifiedByMe", "value": "", "description": "Not documented in the source specification. Optional, boolean.", "disabled": true }, { "key": "scriptEngine", "value": "", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "isValueNonNullable", "value": "", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "includeArchived", "value": "", "description": "Not documented in the source specification. Optional, boolean.", "disabled": true } ] }, "description": "Filters and lists fragments by the given criteria. Required Permissions: Read-Only Assets, Access Design Studio, Access Snippet.\n\n- **Endpoint:** `GET /rest/asset/v2/fragment/filter`\n- **Operation ID:** `filterContentUsingGET_fragment`\n- **API:** Asset API · Fragments (New)\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [List Fragments on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/fragments-new/list-fragments/)\n\n### Parameters\n\n- `access_token` · not sent; see notes · string · required — Token for Authorization.\n- `x-app-type` · header · string · required · Allowed values: `marketo`\n- `workspaceId` · query param · string · required\n- `folderId` · query param · string · optional\n- `folderType` · query param · string · optional · Allowed values: `Folder`, `Program`\n- `status` · query param · array of string · optional\n- `pageIndex` · query param · integer (int32) · optional\n- `pageSize` · query param · integer (int32) · optional\n- `createdAtEnd` · query param · string · optional\n- `createdAtStart` · query param · string · optional\n- `modifiedAtStart` · query param · string · optional\n- `modifiedAtEnd` · query param · string · optional\n- `name` · query param · string · optional\n- `fragmentType` · query param · string · optional\n- `sortKey` · query param · string · optional\n- `sortOrder` · query param · string · optional · Allowed values: `ASC`, `DESC`\n- `isCreatedByMe` · query param · boolean · optional\n- `isModifiedByMe` · query param · boolean · optional\n- `scriptEngine` · query param · string · optional\n- `isValueNonNullable` · query param · string · optional\n- `includeArchived` · query param · boolean · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [FragmentFilterResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/fragmentfilterresponse/)\n- `default` — Error · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/errorresponse/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n- `pageIndex`: Not documented in the source specification.\n- `pageSize`: Maximum value is 50.\n\nThe source specification does not describe `pageIndex`, so this collection does not say whether it counts records or pages. See the [reference page](https://mkto-ref.harrisonjennings.au/reference/asset/fragments-new/list-fragments/), and send each page as a separate request.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value.\n\n### Notes\n\n- The source specification also lists an `access_token` query parameter. This collection sends the token in the `Authorization` header instead, so it is never added to URLs." } }, { "id": "e6d37cb4-a1b3-569e-a0ca-b3e49f33f487", "name": "POST · Update Fragment Status", "request": { "method": "POST", "header": [ { "key": "x-app-type", "value": "marketo", "type": "text", "description": "Application type header. Required, string. Allowed values: `marketo`." } ], "body": { "mode": "raw", "raw": "{\n \"contentId\": null,\n \"action\": null\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v2/fragment/state/transition", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v2", "fragment", "state", "transition" ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nPerforms a state transition on a fragment. Required Permissions: Read-Write Assets, Access Design Studio, Approve Snippet.\n\n- **Endpoint:** `POST /rest/asset/v2/fragment/state/transition`\n- **Operation ID:** `stateTransitionUsingPOST_fragment`\n- **API:** Asset API · Fragments (New)\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Fragment Status on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/fragments-new/update-fragment-status/)\n\n### Parameters\n\n- `access_token` · not sent; see notes · string · required — Token for Authorization.\n- `x-app-type` · header · string · required · Allowed values: `marketo`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [StateTransitionRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/statetransitionrequest/)\n\nThe body starts with the required properties only, set to `null`. Replace each `null` with a value, and add any optional properties you need.\n\n**Properties**\n\n- `contentId` · string · required — Not documented in the source specification.\n- `action` · string · required — The state transition action to perform on the asset. Allowed values: `approve`, `unapprove`, `discard`, `create_draft`.\n\n### Responses\n\n- `200` — OK · [FragmentNewResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/fragmentnewresponse/)\n- `default` — Error · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/errorresponse/)\n\nDeclared response media type: `application/json`.\n\n### Notes\n\n- The source specification also lists an `access_token` query parameter. This collection sends the token in the `Authorization` header instead, so it is never added to URLs." } }, { "id": "12ae627e-064f-51e5-85a9-e22c064d1f24", "name": "POST · Get Fragment Used By", "request": { "method": "POST", "header": [ { "key": "x-app-type", "value": "marketo", "type": "text", "description": "Application type header. Required, string. Allowed values: `marketo`." } ], "body": { "mode": "raw", "raw": "{\n \"assetId\": null\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v2/fragment/usedby", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v2", "fragment", "usedby" ] }, "description": "Returns a list of assets that reference the specified fragment. Required Permissions: Read-Only Assets, Access Design Studio.\n\n- **Endpoint:** `POST /rest/asset/v2/fragment/usedby`\n- **Operation ID:** `getContentUsedByUsingPOST_fragment`\n- **API:** Asset API · Fragments (New)\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Fragment Used By on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/fragments-new/get-fragment-used-by/)\n\n### Parameters\n\n- `access_token` · not sent; see notes · string · required — Token for Authorization.\n- `x-app-type` · header · string · required · Allowed values: `marketo`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [UsedByRequestDto](https://mkto-ref.harrisonjennings.au/reference/asset/models/usedbyrequestdto/)\n\nThe body starts with the required properties only, set to `null`. Replace each `null` with a value, and add any optional properties you need.\n\n**Properties**\n\n- `assetId` · string · required — Not documented in the source specification.\n- `pageIndex` · integer (int32) · optional — Not documented in the source specification.\n- `pageSize` · integer (int32) · optional — Not documented in the source specification.\n- `type` · string · optional — Not documented in the source specification.\n\n### Responses\n\n- `200` — OK · [UsedByResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/usedbyresponse/)\n- `default` — Error · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/errorresponse/)\n\nDeclared response media type: `application/json`.\n\n### Notes\n\n- The source specification also lists an `access_token` query parameter. This collection sends the token in the `Authorization` header instead, so it is never added to URLs." } }, { "id": "1d5f69cf-7813-5b47-9dae-c3b0be5e00de", "name": "GET · Get Fragment by Id", "request": { "method": "GET", "header": [ { "key": "x-app-type", "value": "marketo", "type": "text", "description": "Application type header. Required, string. Allowed values: `marketo`." } ], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v2/fragment/:id", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v2", "fragment", ":id" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, string." } ] }, "description": "Retrieves a fragment by its ID. Required Permissions: Read-Only Assets, Access Design Studio, Access Snippet.\n\n- **Endpoint:** `GET /rest/asset/v2/fragment/{id}`\n- **Operation ID:** `getContentUsingGET_fragment`\n- **API:** Asset API · Fragments (New)\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Fragment by Id on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/fragments-new/get-fragment-by-id/)\n\n### Parameters\n\n- `access_token` · not sent; see notes · string · required — Token for Authorization.\n- `x-app-type` · header · string · required · Allowed values: `marketo`\n- `id` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [FragmentNewResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/fragmentnewresponse/)\n- `default` — Error · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/errorresponse/)\n\nDeclared response media type: `application/json`.\n\n### Notes\n\n- The source specification also lists an `access_token` query parameter. This collection sends the token in the `Authorization` header instead, so it is never added to URLs." } }, { "id": "bd3daf60-7758-5f5b-9aab-180bcb20e655", "name": "POST · Delete Fragment", "request": { "method": "POST", "header": [ { "key": "x-app-type", "value": "marketo", "type": "text", "description": "Application type header. Required, string. Allowed values: `marketo`." } ], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v2/fragment/:id/delete", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v2", "fragment", ":id", "delete" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, string." } ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDeletes a fragment by its ID. Required Permissions: Read-Write Assets, Access Design Studio, Delete Snippet.\n\n- **Endpoint:** `POST /rest/asset/v2/fragment/{id}/delete`\n- **Operation ID:** `deleteContentUsingPOST_fragment`\n- **API:** Asset API · Fragments (New)\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete Fragment on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/fragments-new/delete-fragment/)\n\n### Parameters\n\n- `access_token` · not sent; see notes · string · required — Token for Authorization.\n- `x-app-type` · header · string · required · Allowed values: `marketo`\n- `id` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [DeleteResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/deleteresponse/)\n- `default` — Error · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/errorresponse/)\n\nDeclared response media type: `application/json`.\n\n### Notes\n\n- The source specification also lists an `access_token` query parameter. This collection sends the token in the `Authorization` header instead, so it is never added to URLs." } }, { "id": "9363d7da-ab45-59f1-84f2-2fec599da44c", "name": "POST · Update Fragment", "request": { "method": "POST", "header": [ { "key": "x-app-type", "value": "marketo", "type": "text", "description": "Application type header. Required, string. Allowed values: `marketo`." } ], "body": { "mode": "raw", "raw": "{}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v2/fragment/:id/update", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v2", "fragment", ":id", "update" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, string." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdates an existing fragment. Required Permissions: Read-Write Assets, Access Design Studio, Edit Snippet.\n\n- **Endpoint:** `POST /rest/asset/v2/fragment/{id}/update`\n- **Operation ID:** `updateContentUsingPOST_fragment`\n- **API:** Asset API · Fragments (New)\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Fragment on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/fragments-new/update-fragment/)\n\n### Parameters\n\n- `access_token` · not sent; see notes · string · required — Token for Authorization.\n- `x-app-type` · header · string · required · Allowed values: `marketo`\n- `id` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · optional · model [UpdateFragmentRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/updatefragmentrequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `name` · string · optional — Not documented in the source specification.\n- `description` · string · optional — Not documented in the source specification.\n- `data` · DataDTO · optional — Not documented in the source specification.\n- `data.html` · HtmlDataDTO · optional — Not documented in the source specification.\n- `data.html.body` · string · optional — Not documented in the source specification.\n- `data.text` · TextDataDTO · optional — Not documented in the source specification.\n- `data.text.body` · string · optional — Not documented in the source specification.\n- `data.text.syncFromHtml` · boolean · optional — Not documented in the source specification.\n- `editorContext` · EditorContextDto · optional — Not documented in the source specification.\n- `editorContext.dynamicContent` · object · optional — Not documented in the source specification.\n- `settings` · UpdateFragmentSettingsDTO · optional — Not documented in the source specification.\n- `settings.fragmentType` · string · optional — Not documented in the source specification.\n- `settings.fragmentSubType` · string · optional — Not documented in the source specification.\n- `settings.supportedChannels` · array of string · optional — Not documented in the source specification.\n\n### Responses\n\n- `200` — OK · [FragmentNewResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/fragmentnewresponse/)\n- `default` — Error · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/errorresponse/)\n\nDeclared response media type: `application/json`.\n\n### Notes\n\n- The source specification also lists an `access_token` query parameter. This collection sends the token in the `Authorization` header instead, so it is never added to URLs." } }, { "id": "ccd0c0af-3a81-5646-b7f4-c09499a8c03e", "name": "POST · Bulk Get Fragments", "request": { "method": "POST", "header": [ { "key": "x-app-type", "value": "", "type": "text", "description": "Application type header. Required, string." } ], "body": { "mode": "raw", "raw": "{\n \"assetIds\": []\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v2/fragment/bulk/get", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v2", "fragment", "bulk", "get" ] }, "description": "Retrieves multiple fragments by their IDs in a single request; each asset is returned in full, including its content. Maximum 20 assets per request. Required Permissions: Read-Only Assets, Access Design Studio, Access Snippet.\n\n- **Endpoint:** `POST /rest/asset/v2/fragment/bulk/get`\n- **Operation ID:** `bulkGetUsingPOST_fragment`\n- **API:** Asset API · Fragments (New)\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Bulk Get Fragments on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/fragments-new/bulk-get-fragments/)\n\n### Parameters\n\n- `access_token` · not sent; see notes · string · required — Token for Authorization.\n- `x-app-type` · header · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [BulkGetRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/bulkgetrequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `assetIds` · array of string · required — Set of asset IDs to retrieve. Maximum 20 per request.\n\n### Responses\n\n- `200` — OK · [FragmentNewResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/fragmentnewresponse/)\n- `default` — Error · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/errorresponse/)\n\nDeclared response media type: `application/json`.\n\n### Notes\n\n- The source specification also lists an `access_token` query parameter. This collection sends the token in the `Authorization` header instead, so it is never added to URLs." } }, { "id": "c18b4dfb-2d6a-5b20-9c2f-5c82858ec1b4", "name": "POST · Bulk Delete Fragments", "request": { "method": "POST", "header": [ { "key": "x-app-type", "value": "", "type": "text", "description": "Application type header. Required, string." } ], "body": { "mode": "raw", "raw": "{\n \"assetIds\": []\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v2/fragment/bulk/delete", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v2", "fragment", "bulk", "delete" ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDeletes multiple fragments by their IDs in a single request. Maximum 20 assets per request. Required Permissions: Read-Write Assets, Access Design Studio, Delete Snippet.\n\n- **Endpoint:** `POST /rest/asset/v2/fragment/bulk/delete`\n- **Operation ID:** `bulkDeleteUsingPOST_fragment`\n- **API:** Asset API · Fragments (New)\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Bulk Delete Fragments on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/fragments-new/bulk-delete-fragments/)\n\n### Parameters\n\n- `access_token` · not sent; see notes · string · required — Token for Authorization.\n- `x-app-type` · header · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [BulkDeleteRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/bulkdeleterequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `assetIds` · array of string · required — Set of asset IDs to delete. Maximum 20 per request.\n- `ignoreUsedBy` · boolean · optional — If true, deletes assets even if they are referenced by other assets.\n\n### Responses\n\n- `200` — OK · [DeleteResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/deleteresponse/)\n- `default` — Error · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/errorresponse/)\n\nDeclared response media type: `application/json`.\n\n### Notes\n\n- The source specification also lists an `access_token` query parameter. This collection sends the token in the `Authorization` header instead, so it is never added to URLs." } }, { "id": "0de32803-4d5c-5290-9f07-039166e85e01", "name": "POST · Bulk Get Fragments Used By", "request": { "method": "POST", "header": [ { "key": "x-app-type", "value": "", "type": "text", "description": "Application type header. Required, string." } ], "body": { "mode": "raw", "raw": "{\n \"assetIds\": []\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v2/fragment/bulk/usedby", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v2", "fragment", "bulk", "usedby" ] }, "description": "Returns, for each of the specified fragments, whether it is used and the number of places it is used (count) — not the referencing assets themselves. Maximum 50 assets per request. Required Permissions: Read-Only Assets, Access Design Studio.\n\n- **Endpoint:** `POST /rest/asset/v2/fragment/bulk/usedby`\n- **Operation ID:** `bulkUsedByUsingPOST_fragment`\n- **API:** Asset API · Fragments (New)\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Bulk Get Fragments Used By on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/fragments-new/bulk-get-fragments-used-by/)\n\n### Parameters\n\n- `access_token` · not sent; see notes · string · required — Token for Authorization.\n- `x-app-type` · header · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [BulkUsedByRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/bulkusedbyrequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `assetIds` · array of string · required — Asset IDs to query. Maximum 50 per request.\n\n### Responses\n\n- `200` — OK · [BulkUsedByResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/bulkusedbyresponse/)\n- `default` — Error · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/errorresponse/)\n\nDeclared response media type: `application/json`.\n\n### Notes\n\n- The source specification also lists an `access_token` query parameter. This collection sends the token in the `Authorization` header instead, so it is never added to URLs." } } ] }, { "id": "b0b1596d-bea0-541f-9d11-8e594fc322f0", "name": "Landing Page Content", "description": "Landing Page Content operations in the Asset API. Reference: [Landing Page Content](https://mkto-ref.harrisonjennings.au/reference/asset/landing-page-content/).", "item": [ { "id": "5fffc6b0-da46-5540-82a8-bd9e6a811037", "name": "GET · Get Landing Page Content", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/landingPage/:id/content.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "landingPage", ":id", "content.json" ], "query": [ { "key": "status", "value": "", "description": "Status filter for draft or approved versions. Optional, string. Allowed values: `approved`, `draft`.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "Retrieves the list of content sections in the target landing page. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/landingPage/{id}/content.json`\n- **Operation ID:** `getLandingPageContentUsingGET`\n- **API:** Asset API · Landing Page Content\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Landing Page Content on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/landing-page-content/get-landing-page-content/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `status` · query param · string · optional · Allowed values: `approved`, `draft`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLandingPageContentResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflandingpagecontentresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "07b5bf2e-540e-562b-8d68-d4edbdaa8af3", "name": "POST · Add Landing Page Content Section", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "backgroundColor", "value": "", "type": "text", "description": "background-color property of the HTML section. Optional, string.", "disabled": true }, { "key": "borderColor", "value": "", "type": "text", "description": "border-color property of the HTML section. Optional, string.", "disabled": true }, { "key": "borderStyle", "value": "", "type": "text", "description": "border-style property of the HTML section. Optional, string.", "disabled": true }, { "key": "borderWidth", "value": "", "type": "text", "description": "border-width property of the HTML section. Optional, string.", "disabled": true }, { "key": "contentId", "value": "", "type": "text", "description": "Id of the content section. Also the HTML id of the section. Required, string." }, { "key": "height", "value": "", "type": "text", "description": "height property of the HTML section. Optional, string.", "disabled": true }, { "key": "hideDesktop", "value": "", "type": "text", "description": "Hide the section when displayed on a desktop browser. Default false. Optional, boolean.", "disabled": true }, { "key": "hideMobile", "value": "", "type": "text", "description": "Hide the section when displayed on a mobile browser. Default false. Optional, boolean.", "disabled": true }, { "key": "imageOpenNewWindow", "value": "", "type": "text", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "left", "value": "", "type": "text", "description": "left property of the HTML section. Optional, string.", "disabled": true }, { "key": "linkUrl", "value": "", "type": "text", "description": "URL parameter of a link type section. Optional, string.", "disabled": true }, { "key": "opacity", "value": "", "type": "text", "description": "opacity property of the HTML section. Optional, string.", "disabled": true }, { "key": "top", "value": "", "type": "text", "description": "top property of the HTML section. Optional, string.", "disabled": true }, { "key": "type", "value": "", "type": "text", "description": "Type of content section. Required, string. Allowed values: `Image`, `Form`, `Rectangle`, `Snippet`, `RichText`, `HTML`." }, { "key": "value", "value": "", "type": "text", "description": "Type of content section. Optional, string.", "disabled": true }, { "key": "width", "value": "", "type": "text", "description": "width property of the HTML section. Optional, string.", "disabled": true }, { "key": "zIndex", "value": "", "type": "text", "description": "z-index property of the HTML section. Optional, string.", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/landingPage/:id/content.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "landingPage", ":id", "content.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request adds records or associations in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nAdds 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\n\n- **Endpoint:** `POST /rest/asset/v1/landingPage/{id}/content.json`\n- **Operation ID:** `addLandingPageContentUsingPOST`\n- **API:** Asset API · Landing Page Content\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Add Landing Page Content Section on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/landing-page-content/add-landing-page-content-section/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [CreateLandingPageContentRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/createlandingpagecontentrequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "5c685682-abb0-5479-bbdb-ee70c1ab1518", "name": "POST · Update Landing Page Content Section", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "backgroundColor", "value": "", "type": "text", "description": "background-color property of the HTML section. Optional, string.", "disabled": true }, { "key": "borderColor", "value": "", "type": "text", "description": "border-color property of the HTML section. Optional, string.", "disabled": true }, { "key": "borderStyle", "value": "", "type": "text", "description": "border-style property of the HTML section. Optional, string.", "disabled": true }, { "key": "borderWidth", "value": "", "type": "text", "description": "border-width property of the HTML section. Optional, string.", "disabled": true }, { "key": "height", "value": "", "type": "text", "description": "height property of the HTML section. Optional, string.", "disabled": true }, { "key": "hideDesktop", "value": "", "type": "text", "description": "Hide the section when displayed on a desktop browser. Default false. Optional, boolean.", "disabled": true }, { "key": "hideMobile", "value": "", "type": "text", "description": "Hide the section when displayed on a mobile browser. Default false. Optional, boolean.", "disabled": true }, { "key": "imageOpenNewWindow", "value": "", "type": "text", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "index", "value": "", "type": "text", "description": "Index of the content section. Determines the order of the section in the landing page. Optional, integer (int32).", "disabled": true }, { "key": "left", "value": "", "type": "text", "description": "left property of the HTML section. Optional, string.", "disabled": true }, { "key": "linkUrl", "value": "", "type": "text", "description": "URL parameter of a link type section. Optional, string.", "disabled": true }, { "key": "opacity", "value": "", "type": "text", "description": "opacity property of the HTML section. Optional, string.", "disabled": true }, { "key": "top", "value": "", "type": "text", "description": "top property of the HTML section. Optional, string.", "disabled": true }, { "key": "type", "value": "", "type": "text", "description": "Type of content section. Required, string. Allowed values: `Image`, `Form`, `Rectangle`, `Snippet`, `RichText`, `HTML`, `DynamicContent`." }, { "key": "value", "value": "", "type": "text", "description": "Type of content section. Optional, string.", "disabled": true }, { "key": "width", "value": "", "type": "text", "description": "width property of the HTML section. Optional, string.", "disabled": true }, { "key": "zIndex", "value": "", "type": "text", "description": "z-index property of the HTML section. Optional, string.", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/landingPage/:id/content/:contentId.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "landingPage", ":id", "content", ":contentId.json" ], "variable": [ { "key": "id", "value": "", "description": "Id of landing page. Required, integer (int32)." }, { "key": "contentId", "value": "", "description": "Id of landing page content section. Required, string." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdates a content section the landing page. Parameters must be sent as application/x-www-form-urlencoded (not JSON). Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/landingPage/{id}/content/{contentId}.json`\n- **Operation ID:** `updateLandingPageContentUsingPOST`\n- **API:** Asset API · Landing Page Content\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Landing Page Content Section on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/landing-page-content/update-landing-page-content-section/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `contentId` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [UpdateLandingPageContentRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/updatelandingpagecontentrequest/)\n\nContent properties\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "acc930ba-d773-50ee-bb43-df8678afd1a7", "name": "POST · Delete Landing Page Content Section", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/landingPage/:id/content/:contentId/delete.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "landingPage", ":id", "content", ":contentId", "delete.json" ], "variable": [ { "key": "id", "value": "", "description": "Id of landing page. Required, integer (int32)." }, { "key": "contentId", "value": "", "description": "Id of landing page content section. Required, string." } ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nRemoves the target content section from the parent landing page. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/landingPage/{id}/content/{contentId}/delete.json`\n- **Operation ID:** `removeLandingPageContentUsingPOST`\n- **API:** Asset API · Landing Page Content\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete Landing Page Content Section on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/landing-page-content/delete-landing-page-content-section/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `contentId` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "65816bc7-4d8d-5a8b-a3d0-70f541186c83", "name": "GET · Get Landing Page Dynamic Content", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/landingPage/:id/dynamicContent/:contentId.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "landingPage", ":id", "dynamicContent", ":contentId.json" ], "variable": [ { "key": "id", "value": "", "description": "Id of landing page. Required, integer (int32)." }, { "key": "contentId", "value": "", "description": "Id of landing page dynamic content section. Required, string." } ] }, "description": "Retrieves the dynamic content from the target section. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/landingPage/{id}/dynamicContent/{contentId}.json`\n- **Operation ID:** `getLandingPageDynamicContentsUsingGET`\n- **API:** Asset API · Landing Page Content\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Landing Page Dynamic Content on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/landing-page-content/get-landing-page-dynamic-content/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `contentId` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLandingPageDynamicContentResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflandingpagedynamiccontentresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "239a70fa-c02b-5fcd-b3ea-4aff69ab17fc", "name": "POST · Update Landing Page Dynamic Content Section", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "backgroundColor", "value": "", "type": "text", "description": "background-color property of the HTML section. Optional, string.", "disabled": true }, { "key": "borderColor", "value": "", "type": "text", "description": "border-color property of the HTML section. Optional, string.", "disabled": true }, { "key": "borderStyle", "value": "", "type": "text", "description": "border-style property of the HTML section. Optional, string.", "disabled": true }, { "key": "borderWidth", "value": "", "type": "text", "description": "border-width property of the HTML section. Optional, string.", "disabled": true }, { "key": "height", "value": "", "type": "text", "description": "height property of the HTML section. Optional, string.", "disabled": true }, { "key": "hideDesktop", "value": "", "type": "text", "description": "Hide the section when displayed on a desktop browser. Default false. Optional, boolean.", "disabled": true }, { "key": "hideMobile", "value": "", "type": "text", "description": "Hide the section when displayed on a mobile browser. Default false. Optional, boolean.", "disabled": true }, { "key": "imageOpenNewWindow", "value": "", "type": "text", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "left", "value": "", "type": "text", "description": "left property of the HTML section. Optional, string.", "disabled": true }, { "key": "linkUrl", "value": "", "type": "text", "description": "URL parameter of a link type section. Optional, string.", "disabled": true }, { "key": "opacity", "value": "", "type": "text", "description": "opacity property of the HTML section. Optional, string.", "disabled": true }, { "key": "segment", "value": "", "type": "text", "description": "Name of the segment to display content section for. Optional, string.", "disabled": true }, { "key": "top", "value": "", "type": "text", "description": "top property of the HTML section. Optional, string.", "disabled": true }, { "key": "type", "value": "", "type": "text", "description": "Type of content section. Optional, string.", "disabled": true }, { "key": "value", "value": "", "type": "text", "description": "Type of content section. Optional, string.", "disabled": true }, { "key": "width", "value": "", "type": "text", "description": "width property of the HTML section. Optional, string.", "disabled": true }, { "key": "zIndex", "value": "", "type": "text", "description": "z-index property of the HTML section. Optional, string.", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/landingPage/:id/dynamicContent/:contentId.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "landingPage", ":id", "dynamicContent", ":contentId.json" ], "variable": [ { "key": "id", "value": "", "description": "Id of the landing page. Required, integer (int32)." }, { "key": "contentId", "value": "", "description": "Id of the landing page dynamic content. Required, string." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdates the content of the target dynamic content section. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/landingPage/{id}/dynamicContent/{contentId}.json`\n- **Operation ID:** `updateLandingPageDynamicContentUsingPOST`\n- **API:** Asset API · Landing Page Content\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Landing Page Dynamic Content Section on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/landing-page-content/update-landing-page-dynamic-content-section/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `contentId` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · optional · model [UpdateLandingPageDynamicContentRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/updatelandingpagedynamiccontentrequest/)\n\nDynamic content properties\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } } ] }, { "id": "f79b285a-7936-5649-8197-315bb4c0c170", "name": "Landing Page Redirect Rules", "description": "Landing Page Redirect Rules operations in the Asset API. Reference: [Landing Page Redirect Rules](https://mkto-ref.harrisonjennings.au/reference/asset/landing-page-redirect-rules/).", "item": [ { "id": "c5757c7c-b0db-5fc9-9bc5-35d7ce3a4680", "name": "GET · Get Landing Page Redirect Rules", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/redirectRules.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "redirectRules.json" ], "query": [ { "key": "maxReturn", "value": "", "description": "Maximum number of landing page redirect rules to return. Max 200, default 20. Optional, integer (int32).", "disabled": true }, { "key": "offset", "value": "", "description": "Integer offset for paging. Optional, integer (int32).", "disabled": true }, { "key": "redirectTolandingPageId", "value": "", "description": "Landing page id of landing page to redirect to. Optional, string.", "disabled": true }, { "key": "redirectToPath", "value": "", "description": "Path of landing page to redirect to. Optional, string.", "disabled": true }, { "key": "earliestUpdatedAt", "value": "", "description": "Exclude landing page redirect rules prior to this date. Must be valid ISO-8601 string. See Datetime (http://developers.marketo.com/rest-api/lead-database/fields/field-types/) field type description. Optional, string.", "disabled": true }, { "key": "latestUpdatedAt", "value": "", "description": "Exclude landing page redirect rules after this date. Must be valid ISO-8601 string. See Datetime (http://developers.marketo.com/rest-api/lead-database/fields/field-types/) field type description. Optional, string.", "disabled": true } ] }, "description": "Retrieves a list of landing page redirect rules from the target instance. Required Permissions: Read Only Redirect Rules, Read Write Redirect Rules\n\n- **Endpoint:** `GET /rest/asset/v1/redirectRules.json`\n- **Operation ID:** `getLandingPageRedirectRulesUsingGET`\n- **API:** Asset API · Landing Page Redirect Rules\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Landing Page Redirect Rules on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/landing-page-redirect-rules/get-landing-page-redirect-rules/)\n\n### Parameters\n\n- `maxReturn` · query param · integer (int32) · optional\n- `offset` · query param · integer (int32) · optional\n- `redirectTolandingPageId` · query param · string · optional\n- `redirectToPath` · query param · string · optional\n- `earliestUpdatedAt` · query param · string · optional\n- `latestUpdatedAt` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLandingPageRedirectRules](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflandingpageredirectrules/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n- `offset`: Integer offset for paging.\n- `maxReturn`: Maximum number of landing page redirect rules to return. Max 200, default 20.\n\nAdobe's [Asset API documentation](https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/assets/assets) describes `offset` as the position at which to begin returning results, not a page number. To get the next page, add the `maxReturn` value you used to `offset` and send the request again.\n\nContinue until a response returns no more records. The source specification does not say that a page with fewer than `maxReturn` records is the last one.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "6e64dde7-d323-5bdd-9644-8b5c084918a1", "name": "POST · Create Landing Page Redirect Rule", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "hostname", "value": "", "type": "text", "description": "The hostname for the landing pages. Branding domain or alias. Max 255 characters. Required, string." }, { "key": "redirectFrom", "value": "", "type": "text", "description": "JSON representation of redirect from landing page, with members 'type' which may be 'landingPageId' or 'path', and 'value'. Required, RedirectFrom. Send the value as JSON text; its properties are listed in the request description." }, { "key": "redirectTo", "value": "", "type": "text", "description": "JSON representation of redirect to landing page, with members 'type' which may be 'landingPageId' or 'url', and 'value'. Required, RedirectTo. Send the value as JSON text; its properties are listed in the request description." } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/redirectRules.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "redirectRules.json" ] }, "description": "> **Changes data.** Sending this request creates data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nCreate a new landing page redirect rule. Required Permissions: Read Write Redirect Rules\n\n- **Endpoint:** `POST /rest/asset/v1/redirectRules.json`\n- **Operation ID:** `createLandingPageRedirectRuleUsingPOST`\n- **API:** Asset API · Landing Page Redirect Rules\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Create Landing Page Redirect Rule on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/landing-page-redirect-rules/create-landing-page-redirect-rule/)\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [CreateLandingPageRedirectRuleRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/createlandingpageredirectrulerequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n**Properties of JSON-valued fields**\n\n- `redirectFrom.type` · string · required — Type of redirect landing page. Allowed values: `landingPageId`, `path`.\n- `redirectFrom.value` · string · required — Value for redirect landing page. If type is 'path' this must not begin with forward slash.\n- `redirectTo.type` · string · required — Type of redirect landing page. Allowed values: `landingPageId`, `url`.\n- `redirectTo.value` · string · required — Value for redirect landing page.\n\n### Responses\n\n- `200` — OK · [ResponseOfLandingPageRedirectRules](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflandingpageredirectrules/)\n\nDeclared response media type: `application/json`." } }, { "id": "3164450d-f4d0-52dc-b8fc-918155a38447", "name": "GET · Get Landing Page Redirect Rule by Id", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/redirectRule/:id.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "redirectRule", ":id.json" ], "variable": [ { "key": "id", "value": "", "description": "Id of landing page redirect rule. Required, integer (int32)." } ] }, "description": "Retrieves the landing page redirect rule record. Required Permissions: Read Only Redirect Rules, Read Write Redirect Rules\n\n- **Endpoint:** `GET /rest/asset/v1/redirectRule/{id}.json`\n- **Operation ID:** `getLandingPageRedirectRuleByIdUsingGET`\n- **API:** Asset API · Landing Page Redirect Rules\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Landing Page Redirect Rule by Id on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/landing-page-redirect-rules/get-landing-page-redirect-rule-by-id/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLandingPageRedirectRules](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflandingpageredirectrules/)\n\nDeclared response media type: `application/json`." } }, { "id": "3b1e836e-c950-5609-a568-fbaf55804d2b", "name": "POST · Update Landing Page Redirect Rule", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "hostname", "value": "", "type": "text", "description": "The hostname for the landing pages. Branding domain or alias. Max 255 characters. Optional, string.", "disabled": true }, { "key": "redirectFrom", "value": "", "type": "text", "description": "JSON representation of redirect from landing page, with members 'type' which may be 'landingPageId' or 'path', and 'value'. Optional, RedirectFrom. Send the value as JSON text; its properties are listed in the request description.", "disabled": true }, { "key": "redirectTo", "value": "", "type": "text", "description": "JSON representation of redirect to landing page, with members 'type' which may be 'landingPageId' or 'url', and 'value'. Optional, RedirectTo. Send the value as JSON text; its properties are listed in the request description.", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/redirectRule/:id.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "redirectRule", ":id.json" ], "variable": [ { "key": "id", "value": "", "description": "Id of landing page redirect rule. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdate an existing landing page redirect rule. Required Permissions: Read Write Redirect Rules\n\n- **Endpoint:** `POST /rest/asset/v1/redirectRule/{id}.json`\n- **Operation ID:** `updateLandingPageRedirectRuleUsingPOST`\n- **API:** Asset API · Landing Page Redirect Rules\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Landing Page Redirect Rule on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/landing-page-redirect-rules/update-landing-page-redirect-rule/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [UpdateLandingPageRedirectRuleRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/updatelandingpageredirectrulerequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n**Properties of JSON-valued fields**\n\n- `redirectFrom.type` · string · required — Type of redirect landing page. Allowed values: `landingPageId`, `path`.\n- `redirectFrom.value` · string · required — Value for redirect landing page. If type is 'path' this must not begin with forward slash.\n- `redirectTo.type` · string · required — Type of redirect landing page. Allowed values: `landingPageId`, `url`.\n- `redirectTo.value` · string · required — Value for redirect landing page.\n\n### Responses\n\n- `200` — OK · [ResponseOfLandingPageRedirectRules](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflandingpageredirectrules/)\n\nDeclared response media type: `application/json`." } }, { "id": "e78cee07-c521-5be2-8797-cd5080f52f6e", "name": "POST · Delete Landing Page Redirect Rule", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/redirectRule/:id/delete.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "redirectRule", ":id", "delete.json" ], "variable": [ { "key": "id", "value": "", "description": "Id of landing page redirect rule. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDelete a landing page redirect rule. Required Permissions: Read Write Redirect Rules\n\n- **Endpoint:** `POST /rest/asset/v1/redirectRule/{id}/delete.json`\n- **Operation ID:** `deleteLandingPageRedirectRuleUsingPOST`\n- **API:** Asset API · Landing Page Redirect Rules\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete Landing Page Redirect Rule on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/landing-page-redirect-rules/delete-landing-page-redirect-rule/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "914c552d-c01c-5b75-932a-065a0a1fd1cb", "name": "GET · Get Landing Page Domains", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/landingPageDomains.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "landingPageDomains.json" ], "query": [ { "key": "maxReturn", "value": "", "description": "Maximum number of landing page domains and domain aliases to return. Max 200, default 20. Optional, integer (int32).", "disabled": true }, { "key": "offset", "value": "", "description": "Integer offset for paging. Optional, integer (int32).", "disabled": true } ] }, "description": "Retrieves a list of landing page domain and domain aliases. Required Permissions: Read Only Redirect Rules, Read Write Redirect Rules\n\n- **Endpoint:** `GET /rest/asset/v1/landingPageDomains.json`\n- **Operation ID:** `getLandingPageDomainsUsingGET`\n- **API:** Asset API · Landing Page Redirect Rules\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Landing Page Domains on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/landing-page-redirect-rules/get-landing-page-domains/)\n\n### Parameters\n\n- `maxReturn` · query param · integer (int32) · optional\n- `offset` · query param · integer (int32) · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLandingPageDomains](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflandingpagedomains/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n- `offset`: Integer offset for paging.\n- `maxReturn`: Maximum number of landing page domains and domain aliases to return. Max 200, default 20.\n\nAdobe's [Asset API documentation](https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/assets/assets) describes `offset` as the position at which to begin returning results, not a page number. To get the next page, add the `maxReturn` value you used to `offset` and send the request again.\n\nContinue until a response returns no more records. The source specification does not say that a page with fewer than `maxReturn` records is the last one.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } } ] }, { "id": "6abfa7bb-b9a3-521a-a372-b4551ffd1c03", "name": "Landing Page Templates", "description": "Landing Page Templates operations in the Asset API. Reference: [Landing Page Templates](https://mkto-ref.harrisonjennings.au/reference/asset/landing-page-templates/).", "item": [ { "id": "d1fb48af-b134-52b6-9e91-0d2366bc73a4", "name": "GET · Get Landing Page Template by Name", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/landingPageTemplate/byName.json?name=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "landingPageTemplate", "byName.json" ], "query": [ { "key": "name", "value": "", "description": "Name of the landing page template. Required, string." } ] }, "description": "Retrieves the landing page template record for the given name. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/landingPageTemplate/byName.json`\n- **Operation ID:** `getLandingPageTemplateByNameUsingGET`\n- **API:** Asset API · Landing Page Templates\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Landing Page Template by Name on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/landing-page-templates/get-landing-page-template-by-name/)\n\n### Parameters\n\n- `name` · query param · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLpTemplateResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflptemplateresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "24b0ce14-5a23-5f87-842e-629252e23018", "name": "GET · Get Landing Page Template by Id", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/landingPageTemplate/:id.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "landingPageTemplate", ":id.json" ], "query": [ { "key": "status", "value": "", "description": "Status filter for draft or approved versions. Optional, string. Allowed values: `approved`, `draft`.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "Retrieves the record for the target landing page template. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/landingPageTemplate/{id}.json`\n- **Operation ID:** `getLandingPageTemplateByIdUsingGET`\n- **API:** Asset API · Landing Page Templates\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Landing Page Template by Id on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/landing-page-templates/get-landing-page-template-by-id/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `status` · query param · string · optional · Allowed values: `approved`, `draft`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLpTemplateResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflptemplateresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "f9c387a7-d0a0-5f07-af06-aef50104c2fb", "name": "POST · Update Landing Page Template Metadata", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "description", "value": "", "type": "text", "description": "Description of the landing page template. Optional, string.", "disabled": true }, { "key": "enableMunchkin", "value": "", "type": "text", "description": "Whether to enable munchkin on the derived pages. Defaults to true. Optional, boolean.", "disabled": true }, { "key": "name", "value": "", "type": "text", "description": "Name of the landing page template. Optional, string.", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/landingPageTemplate/:id.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "landingPageTemplate", ":id.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdates the metadata for the target landing page template. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/landingPageTemplate/{id}.json`\n- **Operation ID:** `updateLpTemplateUsingPOST`\n- **API:** Asset API · Landing Page Templates\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Landing Page Template Metadata on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/landing-page-templates/update-landing-page-template-metadata/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [UpdateLpTemplateRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/updatelptemplaterequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n### Responses\n\n- `200` — OK · [ResponseOfLpTemplateResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflptemplateresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "e9e3c877-afb6-5910-9420-0110914dfd5d", "name": "POST · Approve Landing Page Template Draft", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/landingPageTemplate/:id/approveDraft.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "landingPageTemplate", ":id", "approveDraft.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request approves an asset in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nApproves the current landing page template draft. This will delete the current approved version of the template if there is one. Required Permissions: Approve Assets\n\n- **Endpoint:** `POST /rest/asset/v1/landingPageTemplate/{id}/approveDraft.json`\n- **Operation ID:** `approveLandingPageTemplateUsingPOST`\n- **API:** Asset API · Landing Page Templates\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Approve Landing Page Template Draft on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/landing-page-templates/approve-landing-page-template-draft/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLpTemplateResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflptemplateresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "4200f113-db73-5c28-9f1a-d476dbed8996", "name": "POST · Clone Landing Page Template", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "description", "value": "", "type": "text", "description": "Description of the landing page template. Optional, string.", "disabled": true }, { "key": "folder", "value": "", "type": "text", "description": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'. Required, Folder. Send the value as JSON text; its properties are listed in the request description." }, { "key": "name", "value": "", "type": "text", "description": "Name of the landing page template. Required, string." } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/landingPageTemplate/:id/clone.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "landingPageTemplate", ":id", "clone.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request creates a copy of an asset in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nClones the target landing page template. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/landingPageTemplate/{id}/clone.json`\n- **Operation ID:** `cloneLpTemplateUsingPOST`\n- **API:** Asset API · Landing Page Templates\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Clone Landing Page Template on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/landing-page-templates/clone-landing-page-template/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [CloneLpTemplateRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/clonelptemplaterequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n**Properties of JSON-valued fields**\n\n- `folder.id` · integer (int32) · required — Id of the folder.\n- `folder.type` · string · required — Type of folder. Allowed values: `Folder`, `Program`.\n\n### Responses\n\n- `200` — OK · [ResponseOfLpTemplateResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflptemplateresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "b0d4f825-7b95-56ff-9bde-91461a1be1b4", "name": "GET · Get Landing Page Template Content", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/landingPageTemplate/:id/content.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "landingPageTemplate", ":id", "content.json" ], "query": [ { "key": "status", "value": "", "description": "Status filter for draft or approved versions. Optional, string. Allowed values: `approved`, `draft`.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "Retrieves the content of the target landing page. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/landingPageTemplate/{id}/content.json`\n- **Operation ID:** `getLandingPageTemplateContentUsingGET`\n- **API:** Asset API · Landing Page Templates\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Landing Page Template Content on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/landing-page-templates/get-landing-page-template-content/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `status` · query param · string · optional · Allowed values: `approved`, `draft`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLpTemplateGetContentResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflptemplategetcontentresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "65bdf7b5-0343-5662-9158-eed173e69cfe", "name": "POST · Update Landing Page Template Content", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "content", "value": "", "type": "text", "description": "content. Required, string." } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/landingPageTemplate/:id/content.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "landingPageTemplate", ":id", "content.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdates the content for the target landing page template. This update is destructive for the draft version of the template. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/landingPageTemplate/{id}/content.json`\n- **Operation ID:** `updateLandingPageTemplateContentUsingPOST`\n- **API:** Asset API · Landing Page Templates\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Landing Page Template Content on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/landing-page-templates/update-landing-page-template-content/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`multipart/form-data` · required\n\nEach form field is a row in the **Body** tab (form-data), with its description. Required fields are enabled; optional fields are disabled until you enable them. File fields have no file selected.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "063e6d3f-77c4-511b-8150-5846730b3e2b", "name": "POST · Delete Landing Page Template", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/landingPageTemplate/:id/delete.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "landingPageTemplate", ":id", "delete.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDeletes the target landing page template. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/landingPageTemplate/{id}/delete.json`\n- **Operation ID:** `deleteLpTemplateUsingPOST`\n- **API:** Asset API · Landing Page Templates\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete Landing Page Template on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/landing-page-templates/delete-landing-page-template/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "d76f6010-36bf-57b8-92e0-b4eeb580e896", "name": "POST · Discard Landing Page Template Draft", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/landingPageTemplate/:id/discardDraft.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "landingPageTemplate", ":id", "discardDraft.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request discards a draft in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDiscrads the current draft of the landing page template. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/landingPageTemplate/{id}/discardDraft.json`\n- **Operation ID:** `discardDraftUsingPOST_2`\n- **API:** Asset API · Landing Page Templates\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Discard Landing Page Template Draft on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/landing-page-templates/discard-landing-page-template-draft/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "ff95a4f9-6eb1-5eef-b4b5-2c4b5e6345c6", "name": "POST · Unapprove Landing Page Template", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/landingPageTemplate/:id/unapprove.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "landingPageTemplate", ":id", "unapprove.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request unapproves an asset in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUnapproves the landing page template and reverts it to a draft-only state. Required Permissions: Approve Assets\n\n- **Endpoint:** `POST /rest/asset/v1/landingPageTemplate/{id}/unapprove.json`\n- **Operation ID:** `unapproveLandingPageTemplateUsingPOST`\n- **API:** Asset API · Landing Page Templates\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Unapprove Landing Page Template on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/landing-page-templates/unapprove-landing-page-template/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLpTemplateResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflptemplateresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "a1ab3b6d-19bb-58d2-a94f-c18b94d21a0d", "name": "GET · Get Landing Page Templates", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/landingPageTemplates.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "landingPageTemplates.json" ], "query": [ { "key": "maxReturn", "value": "", "description": "Maximum number of records to return. Max 200, default 20. Optional, integer (int32).", "disabled": true }, { "key": "offset", "value": "", "description": "Integer offset for paging. Optional, integer (int32).", "disabled": true }, { "key": "status", "value": "", "description": "Status filter for draft or approved versions. Optional, string. Allowed values: `approved`, `draft`.", "disabled": true }, { "key": "folder", "value": "", "description": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'. Optional, string.", "disabled": true } ] }, "description": "Retrieves the list of accessible landing page templates from the target instance. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/landingPageTemplates.json`\n- **Operation ID:** `getLandingPageTemplatesUsingGET`\n- **API:** Asset API · Landing Page Templates\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Landing Page Templates on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/landing-page-templates/get-landing-page-templates/)\n\n### Parameters\n\n- `maxReturn` · query param · integer (int32) · optional\n- `offset` · query param · integer (int32) · optional\n- `status` · query param · string · optional · Allowed values: `approved`, `draft`\n- `folder` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLpTemplateResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflptemplateresponse/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n- `offset`: Integer offset for paging.\n- `maxReturn`: Maximum number of records to return. Max 200, default 20.\n\nAdobe's [Asset API documentation](https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/assets/assets) describes `offset` as the position at which to begin returning results, not a page number. To get the next page, add the `maxReturn` value you used to `offset` and send the request again.\n\nContinue until a response returns no more records. The source specification does not say that a page with fewer than `maxReturn` records is the last one.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "c85a50cd-28ff-5eec-bd32-274afd6bf849", "name": "POST · Create Landing Page Template", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "description", "value": "", "type": "text", "description": "Description of the landing page template. Optional, string.", "disabled": true }, { "key": "enableMunchkin", "value": "", "type": "text", "description": "Whether to enable munchkin on the derived pages. Defaults to true. Optional, boolean.", "disabled": true }, { "key": "folder", "value": "", "type": "text", "description": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'. Required, Folder. Send the value as JSON text; its properties are listed in the request description." }, { "key": "name", "value": "", "type": "text", "description": "Name of the landing page template. Required, string." }, { "key": "templateType", "value": "", "type": "text", "description": "Type of template to create. Defaults to freeForm. Optional, string. Allowed values: `guided`, `freeForm`.", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/landingPageTemplates.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "landingPageTemplates.json" ] }, "description": "> **Changes data.** Sending this request creates data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nCreates a new landing page template. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/landingPageTemplates.json`\n- **Operation ID:** `createLpTemplateUsingPOST`\n- **API:** Asset API · Landing Page Templates\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Create Landing Page Template on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/landing-page-templates/create-landing-page-template/)\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [CreateLpTemplateRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/createlptemplaterequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n**Properties of JSON-valued fields**\n\n- `folder.id` · integer (int32) · required — Id of the folder.\n- `folder.type` · string · required — Type of folder. Allowed values: `Folder`, `Program`.\n\n### Responses\n\n- `200` — OK · [ResponseOfLpTemplateResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflptemplateresponse/)\n\nDeclared response media type: `application/json`." } } ] }, { "id": "147fd0b6-1074-5d76-8132-c5328f45233b", "name": "Landing Pages", "description": "Landing Pages operations in the Asset API. Reference: [Landing Pages](https://mkto-ref.harrisonjennings.au/reference/asset/landing-pages/).", "item": [ { "id": "6412f342-f257-5a6a-a6c4-f3fc2bb56fe9", "name": "GET · Get Landing Page by Name", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/landingPage/byName.json?name=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "landingPage", "byName.json" ], "query": [ { "key": "name", "value": "", "description": "Name of the landing page. Required, string." }, { "key": "status", "value": "", "description": "Status filter for draft or approved versions. Optional, string. Allowed values: `approved`, `draft`.", "disabled": true }, { "key": "maxReturn", "value": "", "description": "Maximum number of records to return. Max 200, default 20. Optional, integer (int32).", "disabled": true }, { "key": "offset", "value": "", "description": "Integer offset for paging. Optional, integer (int32).", "disabled": true } ] }, "description": "Returns the landing page record for the given name. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/landingPage/byName.json`\n- **Operation ID:** `getLandingPageByNameUsingGET`\n- **API:** Asset API · Landing Pages\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Landing Page by Name on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/landing-pages/get-landing-page-by-name/)\n\n### Parameters\n\n- `name` · query param · string · required\n- `status` · query param · string · optional · Allowed values: `approved`, `draft`\n- `maxReturn` · query param · integer (int32) · optional\n- `offset` · query param · integer (int32) · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLandingPageResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflandingpageresponse/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n- `offset`: Integer offset for paging.\n- `maxReturn`: Maximum number of records to return. Max 200, default 20.\n\nAdobe's [Asset API documentation](https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/assets/assets) describes `offset` as the position at which to begin returning results, not a page number. To get the next page, add the `maxReturn` value you used to `offset` and send the request again.\n\nContinue until a response returns no more records. The source specification does not say that a page with fewer than `maxReturn` records is the last one.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "bf17094f-9735-5d12-a915-c4dac8419f32", "name": "GET · Get Landing Page by Id", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/landingPage/:id.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "landingPage", ":id.json" ], "query": [ { "key": "status", "value": "", "description": "Status filter for draft or approved versions. Optional, string. Allowed values: `approved`, `draft`.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "Returns the landing record for the given id. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/landingPage/{id}.json`\n- **Operation ID:** `getLandingPageByIdUsingGET`\n- **API:** Asset API · Landing Pages\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Landing Page by Id on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/landing-pages/get-landing-page-by-id/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `status` · query param · string · optional · Allowed values: `approved`, `draft`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLandingPageResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflandingpageresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "b22579b5-bdf3-5e7d-8086-1aeaa8146571", "name": "POST · Update Landing Page Metadata", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "customHeadHTML", "value": "", "type": "text", "description": "Any custom HTML to embed in the tag of the page. Optional, string.", "disabled": true }, { "key": "description", "value": "", "type": "text", "description": "Description of the asset. Optional, string.", "disabled": true }, { "key": "facebookOgTags", "value": "", "type": "text", "description": "Any OpenGraph meta tags to apply to the page. Optional, string.", "disabled": true }, { "key": "keywords", "value": "", "type": "text", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "metaTagsDescription", "value": "", "type": "text", "description": "Meta description property of the page. Optional, string.", "disabled": true }, { "key": "mobileEnabled", "value": "", "type": "text", "description": "Whether the page has mobile viewing enabled. Free-form pages only. Default false. Optional, boolean.", "disabled": true }, { "key": "name", "value": "", "type": "text", "description": "Name of the landing page. Optional, string.", "disabled": true }, { "key": "robots", "value": "", "type": "text", "description": "Robots directives to apply to the pages meta tags. Optional, string.", "disabled": true }, { "key": "styleOverRide", "value": "", "type": "text", "description": "Additional CSS styles to append to the landing page . Optional, string.", "disabled": true }, { "key": "title", "value": "", "type": "text", "description": "Title element of the landing page. Optional, string.", "disabled": true }, { "key": "urlPageName", "value": "", "type": "text", "description": "URL path of the page. Derived from the name field if unset. Optional, string.", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/landingPage/:id.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "landingPage", ":id.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdates the metadata for the targe landing page. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/landingPage/{id}.json`\n- **Operation ID:** `updateLandingPageUsingPOST`\n- **API:** Asset API · Landing Pages\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Landing Page Metadata on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/landing-pages/update-landing-page-metadata/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [UpdateLandingPageRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/updatelandingpagerequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n### Responses\n\n- `200` — OK · [ResponseOfLandingPageResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflandingpageresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "0b63255f-94c4-5b67-a19a-fbd048b56a47", "name": "POST · Approve Landing Page Draft", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/landingPage/:id/approveDraft.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "landingPage", ":id", "approveDraft.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request approves an asset in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nApproves the current draft of the landing page. Required Permissions: Approve Assets\n\n- **Endpoint:** `POST /rest/asset/v1/landingPage/{id}/approveDraft.json`\n- **Operation ID:** `approveLandingPageUsingPOST`\n- **API:** Asset API · Landing Pages\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Approve Landing Page Draft on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/landing-pages/approve-landing-page-draft/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "6a81cbfa-dc54-54cd-b514-0243ed639977", "name": "POST · Clone Landing Page", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "description", "value": "", "type": "text", "description": "Description of the asset. Optional, string.", "disabled": true }, { "key": "folder", "value": "", "type": "text", "description": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'. Required, Folder. Send the value as JSON text; its properties are listed in the request description." }, { "key": "name", "value": "", "type": "text", "description": "Name of the landing page. Required, string." }, { "key": "template", "value": "", "type": "text", "description": "Id of the template used. Optional, integer (int32).", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/landingPage/:id/clone.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "landingPage", ":id", "clone.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request creates a copy of an asset in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nClones the target landing page. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/landingPage/{id}/clone.json`\n- **Operation ID:** `cloneLandingPageUsingPOST`\n- **API:** Asset API · Landing Pages\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Clone Landing Page on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/landing-pages/clone-landing-page/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [CloneLandingPageRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/clonelandingpagerequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n**Properties of JSON-valued fields**\n\n- `folder.id` · integer (int32) · required — Id of the folder.\n- `folder.type` · string · required — Type of folder. Allowed values: `Folder`, `Program`.\n\n### Responses\n\n- `200` — OK · [ResponseOfLandingPageResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflandingpageresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "fcb8a40b-0eec-5649-906c-6f8235db7e1e", "name": "POST · Delete Landing Page", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/landingPage/:id/delete.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "landingPage", ":id", "delete.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDeletes the target landing page. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/landingPage/{id}/delete.json`\n- **Operation ID:** `deleteLandingPageByIdUsingPOST`\n- **API:** Asset API · Landing Pages\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete Landing Page on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/landing-pages/delete-landing-page/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "e6bf7810-e0ad-5a8c-a1f9-3207fef5839e", "name": "POST · Discard Landing Page Draft", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/landingPage/:id/discardDraft.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "landingPage", ":id", "discardDraft.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request discards a draft in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDiscards the current draft of the landing page. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/landingPage/{id}/discardDraft.json`\n- **Operation ID:** `discardLandingPageByIdUsingPOST`\n- **API:** Asset API · Landing Pages\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Discard Landing Page Draft on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/landing-pages/discard-landing-page-draft/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "c1206f2e-6e9f-5d5a-ae7e-a5ba06262bf8", "name": "POST · Unapprove Landing Page", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/landingPage/:id/unapprove.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "landingPage", ":id", "unapprove.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request unapproves an asset in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUnapproves the landing page, reverting it to a draft-only state. Required Permissions: Approve Assets\n\n- **Endpoint:** `POST /rest/asset/v1/landingPage/{id}/unapprove.json`\n- **Operation ID:** `unapproveLandingPageByIdUsingPOST`\n- **API:** Asset API · Landing Pages\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Unapprove Landing Page on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/landing-pages/unapprove-landing-page/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLandingPageResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflandingpageresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "60bcdf6c-43f2-5b9f-81a0-6ac068656295", "name": "POST · Update Landing Page Variable", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/landingPage/:id/variable/:variableId.json?value=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "landingPage", ":id", "variable", ":variableId.json" ], "query": [ { "key": "value", "value": "", "description": "New value of the variable. Required, integer (int32)." } ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." }, { "key": "variableId", "value": "", "description": "variableId. Required, string." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdates the value of the given variable. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/landingPage/{id}/variable/{variableId}.json`\n- **Operation ID:** `updateLandingPageVariableUsingPOST`\n- **API:** Asset API · Landing Pages\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Landing Page Variable on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/landing-pages/update-landing-page-variable/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `variableId` · path variable · string · required\n- `value` · query param · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLandingPageVariableResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflandingpagevariableresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "63ddddd6-a56c-535d-ab57-b395292af702", "name": "GET · Get Landing Page Variables", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/landingPage/:id/variables.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "landingPage", ":id", "variables.json" ], "query": [ { "key": "status", "value": "", "description": "Status filter for draft or approved versions. Optional, string. Allowed values: `approved`, `draft`.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "Id of the landing page. Required, integer (int32)." } ] }, "description": "Get Landing Page Variables\n\n- **Endpoint:** `GET /rest/asset/v1/landingPage/{id}/variables.json`\n- **Operation ID:** `getVariablesUsingGET`\n- **API:** Asset API · Landing Pages\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Landing Page Variables on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/landing-pages/get-landing-page-variables/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `status` · query param · string · optional · Allowed values: `approved`, `draft`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLandingPageVariableResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflandingpagevariableresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "86868c27-4154-5280-accf-a137cbe4f36f", "name": "GET · Get Landing Pages", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/landingPages.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "landingPages.json" ], "query": [ { "key": "status", "value": "", "description": "Status filter for draft or approved versions. Optional, string. Allowed values: `approved`, `draft`.", "disabled": true }, { "key": "maxReturn", "value": "", "description": "Maximum number of landing pages to return. Max 200, default 20. Optional, integer (int32).", "disabled": true }, { "key": "offset", "value": "", "description": "Integer offset for paging. Optional, integer (int32).", "disabled": true }, { "key": "folder", "value": "", "description": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'. Optional, string.", "disabled": true } ] }, "description": "Retrieves a list of accessible landing pages from the target instance. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/landingPages.json`\n- **Operation ID:** `browseLandingPagesUsingGET`\n- **API:** Asset API · Landing Pages\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Landing Pages on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/landing-pages/get-landing-pages/)\n\n### Parameters\n\n- `status` · query param · string · optional · Allowed values: `approved`, `draft`\n- `maxReturn` · query param · integer (int32) · optional\n- `offset` · query param · integer (int32) · optional\n- `folder` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLandingPageResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflandingpageresponse/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n- `offset`: Integer offset for paging.\n- `maxReturn`: Maximum number of landing pages to return. Max 200, default 20.\n\nAdobe's [Asset API documentation](https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/assets/assets) describes `offset` as the position at which to begin returning results, not a page number. To get the next page, add the `maxReturn` value you used to `offset` and send the request again.\n\nContinue until a response returns no more records. The source specification does not say that a page with fewer than `maxReturn` records is the last one.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "d5420257-7a8e-5866-9cd4-70d33d9e00e4", "name": "POST · Create Landing Page", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "customHeadHTML", "value": "", "type": "text", "description": "Any custom HTML to embed in the tag of the page. Optional, string.", "disabled": true }, { "key": "description", "value": "", "type": "text", "description": "Description of the asset. Optional, string.", "disabled": true }, { "key": "facebookOgTags", "value": "", "type": "text", "description": "Any OpenGraph meta tags to apply to the page. Optional, string.", "disabled": true }, { "key": "folder", "value": "", "type": "text", "description": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'. Required, Folder. Send the value as JSON text; its properties are listed in the request description." }, { "key": "keywords", "value": "", "type": "text", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "mobileEnabled", "value": "", "type": "text", "description": "Whether the page has mobile viewing enabled. Free-form pages only. Default false. Optional, boolean.", "disabled": true }, { "key": "name", "value": "", "type": "text", "description": "Name of the landing page. Required, string." }, { "key": "prefillForm", "value": "", "type": "text", "description": "Boolean to toggle whether forms embedded in the page will prefill. Default false. Optional, boolean.", "disabled": true }, { "key": "robots", "value": "", "type": "text", "description": "Robots directives to apply to the pages meta tags. Optional, string.", "disabled": true }, { "key": "template", "value": "", "type": "text", "description": "Id of the template used. Required, integer (int32)." }, { "key": "title", "value": "", "type": "text", "description": "Title element of the landing page. Optional, string.", "disabled": true }, { "key": "urlPageName", "value": "", "type": "text", "description": "URL path of the page. Derived from the name field if unset. Optional, string.", "disabled": true }, { "key": "workspace", "value": "", "type": "text", "description": "Name of the workspace. Optional, string.", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/landingPages.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "landingPages.json" ] }, "description": "> **Changes data.** Sending this request creates data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nCreates a new landing page. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/landingPages.json`\n- **Operation ID:** `createLandingPageUsingPOST`\n- **API:** Asset API · Landing Pages\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Create Landing Page on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/landing-pages/create-landing-page/)\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [CreateLandingPageRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/createlandingpagerequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n**Properties of JSON-valued fields**\n\n- `folder.id` · integer (int32) · required — Id of the folder.\n- `folder.type` · string · required — Type of folder. Allowed values: `Folder`, `Program`.\n\n### Responses\n\n- `200` — OK · [ResponseOfLandingPageResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoflandingpageresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "132719a2-f0d5-50b0-a61a-e2737e62b678", "name": "GET · Get Landing Page Full Content", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/landingPage/:id/fullContent.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "landingPage", ":id", "fullContent.json" ], "query": [ { "key": "leadId", "value": "", "description": "The lead id to impersonate. Landing page is rendered as though it was viewed by this lead. Optional, integer (int32).", "disabled": true }, { "key": "segmentation", "value": "", "description": "JSON array of of segmentations. Each segmentation must be a JSON object with members 'segmentationId', and 'segmentId'. Example: [{\"segmentationId\":1030,\"segmentId\":1103}]. Optional, string.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "Id of the landing page. Required, integer (int32)." } ] }, "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.\n\n- **Endpoint:** `GET /rest/asset/v1/landingPage/{id}/fullContent.json`\n- **Operation ID:** `getLandingPageFullContentUsingGET`\n- **API:** Asset API · Landing Pages\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Landing Page Full Content on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/landing-pages/get-landing-page-full-content/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `leadId` · query param · integer (int32) · optional\n- `segmentation` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfGetLandingPageFullContentResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofgetlandingpagefullcontentresponse/)\n\nDeclared response media type: `application/json`." } } ] }, { "id": "2b7b282a-01b1-501d-9381-63f9eb007c4e", "name": "Programs", "description": "Programs operations in the Asset API. Reference: [Programs](https://mkto-ref.harrisonjennings.au/reference/asset/programs/).", "item": [ { "id": "195d08d1-1ac9-517f-8890-deda0c05a4c3", "name": "GET · Get Program by Name", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/program/byName.json?name=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "program", "byName.json" ], "query": [ { "key": "name", "value": "", "description": "Name of the program. Required, string." }, { "key": "includeTags", "value": "", "description": "Set true to populate program tags. Optional, boolean.", "disabled": true }, { "key": "includeCosts", "value": "", "description": "Set true to populate program costs. Optional, boolean.", "disabled": true } ] }, "description": "Retrieves the program record for the given name. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/program/byName.json`\n- **Operation ID:** `getProgramByNameUsingGET`\n- **API:** Asset API · Programs\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Program by Name on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/programs/get-program-by-name/)\n\n### Parameters\n\n- `name` · query param · string · required\n- `includeTags` · query param · boolean · optional\n- `includeCosts` · query param · boolean · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfProgramResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofprogramresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "747b63ef-78b3-5072-a9f1-475b1e0f0f74", "name": "GET · Get Programs by Tag", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/program/byTag.json?tagType=&tagValue=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "program", "byTag.json" ], "query": [ { "key": "tagType", "value": "", "description": "Type of program tag. Required, string." }, { "key": "tagValue", "value": "", "description": "Value of the tag. Required, string." }, { "key": "maxReturn", "value": "", "description": "Maximum number of records to return. Max 200, default 20. Optional, integer (int32).", "disabled": true }, { "key": "offset", "value": "", "description": "Integer offset for paging. Optional, integer (int32).", "disabled": true } ] }, "description": "Retrieves a list of programs matching the tag type and tag values given. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/program/byTag.json`\n- **Operation ID:** `getProgramListByTagUsingGET`\n- **API:** Asset API · Programs\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Programs by Tag on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/programs/get-programs-by-tag/)\n\n### Parameters\n\n- `tagType` · query param · string · required\n- `tagValue` · query param · string · required\n- `maxReturn` · query param · integer (int32) · optional\n- `offset` · query param · integer (int32) · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfProgramResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofprogramresponse/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n- `offset`: Integer offset for paging.\n- `maxReturn`: Maximum number of records to return. Max 200, default 20.\n\nAdobe's [Asset API documentation](https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/assets/assets) describes `offset` as the position at which to begin returning results, not a page number. To get the next page, add the `maxReturn` value you used to `offset` and send the request again.\n\nContinue until a response returns no more records. The source specification does not say that a page with fewer than `maxReturn` records is the last one.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "995833d2-74a2-5d2b-8a29-673526e1dd3f", "name": "GET · Get Program by Id", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/program/:id.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "program", ":id.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "Retrieves the program record for the given id. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/program/{id}.json`\n- **Operation ID:** `getProgramByIdUsingGET`\n- **API:** Asset API · Programs\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Program by Id on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/programs/get-program-by-id/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfProgramResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofprogramresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "dba1875c-bf98-5859-9d99-01f8b8889517", "name": "POST · Update Program Metadata", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "channel", "value": "", "type": "text", "description": "Channel of the program. The channel must be valid for the program's type. Updating the channel keeps Program Settings Channel and the Channel tag in sync. If a Channel tag is also passed in tags, the channel value takes precedence. The update is rejected with error code 1173 if a child campaign uses a Change Program Status flow step. Optional, string.", "disabled": true }, { "key": "costs", "value": "", "type": "text", "description": "Lists of associated period costs that allow you to append, replace, or delete. To append new costs, simply add them to costs array. To replace costs (destructive update), pass new costs and set costsDestructiveUpdate to true. To delete costs, do not pass costs parameter and set costsDestructiveUpdate to true. Optional, array of CostRequest. Send the value as JSON text; its properties are listed in the request description.", "disabled": true }, { "key": "costsDestructiveUpdate", "value": "", "type": "text", "description": "Set true to destroy existing costs and replace them with the specified costs. Optional, boolean.", "disabled": true }, { "key": "description", "value": "", "type": "text", "description": "Updated description for the program. Optional, string.", "disabled": true }, { "key": "endDate", "value": "", "type": "text", "description": "End date of the program. Applicable to event, email, and webinar type programs. Optional, string.", "disabled": true }, { "key": "name", "value": "", "type": "text", "description": "Name of the program. Optional, string.", "disabled": true }, { "key": "startDate", "value": "", "type": "text", "description": "Start date of program. Applicable to event, email and webinar type programs. Optional, string.", "disabled": true }, { "key": "tags", "value": "", "type": "text", "description": "List of associated program tags. Optional, array of TagRequest. Send the value as JSON text; its properties are listed in the request description.", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/program/:id.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "program", ":id.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdates the target program's metadata. The channel may be updated after creation; doing so keeps Program Settings Channel and the Channel tag in sync, and is rejected if a child campaign uses a Change Program Status flow step. The type may only be set at creation. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/program/{id}.json`\n- **Operation ID:** `updateProgramUsingPOST`\n- **API:** Asset API · Programs\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Program Metadata on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/programs/update-program-metadata/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [UpdateProgramRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/updateprogramrequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n**Properties of JSON-valued fields**\n\n- `costs[].cost` · integer (int32) · required — Amount of the cost.\n- `costs[].note` · string · optional — Notes on the cost.\n- `costs[].startDate` · string (date-time) · required — Start date of the period cost.\n- `tags[].tagType` · string · optional — Type of program tag.\n- `tags[].tagValue` · string · optional — Value of the tag.\n\n### Responses\n\n- `200` — OK · [ResponseOfProgramResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofprogramresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "778b0e76-4cb2-55ae-bc20-355065b11b41", "name": "GET · Get Smart List by Program Id", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/program/:programId/smartList.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "program", ":programId", "smartList.json" ], "query": [ { "key": "includeRules", "value": "", "description": "Set true to populate smart list rules. Default false. Optional, boolean.", "disabled": true } ], "variable": [ { "key": "programId", "value": "", "description": "Id for the email program containing smart list to retrieve. Required, integer (int64)." } ] }, "description": "Retrieves a Smart List record by its Email Program id. Required Permissions: Read-Asset or Read-Write Asset\n\n- **Endpoint:** `GET /rest/asset/v1/program/{programId}/smartList.json`\n- **Operation ID:** `getSmartListByProgramIdUsingGET`\n- **API:** Asset API · Programs\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Smart List by Program Id on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/programs/get-smart-list-by-program-id/)\n\n### Parameters\n\n- `programId` · path variable · integer (int64) · required\n- `includeRules` · query param · boolean · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfSmartListResponseWithRules](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsmartlistresponsewithrules/)\n\nDeclared response media type: `application/json`." } }, { "id": "a6b6c995-80fd-57ae-9a80-c45ab2953489", "name": "POST · Approve Program", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/program/:id/approve.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "program", ":id", "approve.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request approves an asset in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nApproves the target program. Only valid for unapproved email programs. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/program/{id}/approve.json`\n- **Operation ID:** `approveProgramUsingPOST`\n- **API:** Asset API · Programs\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Approve Program on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/programs/approve-program/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "25a4fbad-d489-5ff0-9181-89ce20a17ec5", "name": "POST · Clone Program", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "description", "value": "", "type": "text", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "folder", "value": "", "type": "text", "description": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'. Required, Folder. Send the value as JSON text; its properties are listed in the request description." }, { "key": "name", "value": "", "type": "text", "description": "Name of the program. Max 255 characters. Required, string." } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/program/:id/clone.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "program", ":id", "clone.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request creates a copy of an asset in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nClones the target program. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/program/{id}/clone.json`\n- **Operation ID:** `cloneProgramUsingPOST`\n- **API:** Asset API · Programs\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Clone Program on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/programs/clone-program/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [CloneProgramRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/cloneprogramrequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n**Properties of JSON-valued fields**\n\n- `folder.id` · integer (int32) · required — Id of the folder.\n- `folder.type` · string · required — Type of folder. Allowed values: `Folder`, `Program`.\n\n### Responses\n\n- `200` — OK · [ResponseOfProgramResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofprogramresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "ebc3f970-781b-59d2-8306-590564d21d2e", "name": "POST · Delete Program", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/program/:id/delete.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "program", ":id", "delete.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDeletes the target program. The program may not contain any assets which are in use outside the program. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/program/{id}/delete.json`\n- **Operation ID:** `deleteProgramUsingPOST`\n- **API:** Asset API · Programs\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete Program on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/programs/delete-program/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "a51a5989-9349-5dba-8446-e4f97c003c34", "name": "POST · Unapprove Program", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/program/:id/unapprove.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "program", ":id", "unapprove.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request unapproves an asset in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUnapproves the target program. Only valid for approved email programs. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/program/{id}/unapprove.json`\n- **Operation ID:** `unapproveProgramUsingPOST`\n- **API:** Asset API · Programs\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Unapprove Program on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/programs/unapprove-program/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "bba62fdd-86de-5e78-a0de-85a9742c3363", "name": "GET · Get Programs", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/programs.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "programs.json" ], "query": [ { "key": "maxReturn", "value": "", "description": "Maximum number of records to return. Max 200, default 20. Optional, integer (int32).", "disabled": true }, { "key": "offset", "value": "", "description": "Integer offset for paging. Optional, integer (int32).", "disabled": true }, { "key": "filterType", "value": "", "description": "Optional filter. Requires filterValues. Optional, string. Allowed values: `id`, `programId`, `folderId`, `workspace`.", "disabled": true }, { "key": "earliestUpdatedAt", "value": "", "description": "Exclude programs prior to this date. Must be valid ISO-8601 string. See Datetime (http://developers.marketo.com/rest-api/lead-database/fields/field-types/) field type description. Optional, string.", "disabled": true }, { "key": "latestUpdatedAt", "value": "", "description": "Exclude programs after this date. Must be valid ISO-8601 string. See Datetime (http://developers.marketo.com/rest-api/lead-database/fields/field-types/) field type description. Optional, string.", "disabled": true } ] }, "description": "Retrieves the list of accessible programs from the target instance. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/programs.json`\n- **Operation ID:** `browseProgramsUsingGET`\n- **API:** Asset API · Programs\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Programs on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/programs/get-programs/)\n\n### Parameters\n\n- `maxReturn` · query param · integer (int32) · optional\n- `offset` · query param · integer (int32) · optional\n- `filterType` · query param · string · optional · Allowed values: `id`, `programId`, `folderId`, `workspace`\n- `earliestUpdatedAt` · query param · string · optional\n- `latestUpdatedAt` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfBrowseAllPrograms](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofbrowseallprograms/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n- `offset`: Integer offset for paging.\n- `maxReturn`: Maximum number of records to return. Max 200, default 20.\n\nAdobe's [Asset API documentation](https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/assets/assets) describes `offset` as the position at which to begin returning results, not a page number. To get the next page, add the `maxReturn` value you used to `offset` and send the request again.\n\nContinue until a response returns no more records. The source specification does not say that a page with fewer than `maxReturn` records is the last one.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "72d4ecea-a8c3-5bc6-9651-100b251d98bb", "name": "POST · Create Program", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "channel", "value": "", "type": "text", "description": "Channel of the program. Required, string." }, { "key": "costs", "value": "", "type": "text", "description": "Lists of associated period costs. Optional, array of CostRequest. Send the value as JSON text; its properties are listed in the request description.", "disabled": true }, { "key": "description", "value": "", "type": "text", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "folder", "value": "", "type": "text", "description": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'. Required, Folder. Send the value as JSON text; its properties are listed in the request description." }, { "key": "name", "value": "", "type": "text", "description": "Name of the program. Required, string." }, { "key": "tags", "value": "", "type": "text", "description": "List of associated program tags. Optional, array of TagRequest. Send the value as JSON text; its properties are listed in the request description.", "disabled": true }, { "key": "type", "value": "", "type": "text", "description": "Type of the program. Required, string." } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/programs.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "programs.json" ] }, "description": "> **Changes data.** Sending this request creates data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nCreates a new program. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/programs.json`\n- **Operation ID:** `createProgramUsingPOST`\n- **API:** Asset API · Programs\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Create Program on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/programs/create-program/)\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [CreateProgramRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/createprogramrequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n**Properties of JSON-valued fields**\n\n- `costs[].cost` · integer (int32) · required — Amount of the cost.\n- `costs[].note` · string · optional — Notes on the cost.\n- `costs[].startDate` · string (date-time) · required — Start date of the period cost.\n- `folder.id` · integer (int32) · required — Id of the folder.\n- `folder.type` · string · required — Type of folder. Allowed values: `Folder`, `Program`.\n- `tags[].tagType` · string · optional — Type of program tag.\n- `tags[].tagValue` · string · optional — Value of the tag.\n\n### Responses\n\n- `200` — OK · [ResponseOfProgramResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofprogramresponse/)\n\nDeclared response media type: `application/json`." } } ] }, { "id": "db8314c3-4ab1-5247-ae6f-28908952b068", "name": "Segments", "description": "Segments operations in the Asset API. Reference: [Segments](https://mkto-ref.harrisonjennings.au/reference/asset/segments/).", "item": [ { "id": "8be80fdd-dde3-5e00-bc76-5ea225c5cbe1", "name": "GET · Get Segmentations", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/segmentation.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "segmentation.json" ], "query": [ { "key": "status", "value": "", "description": "Status filter for draft or approved versions. Optional, string. Allowed values: `approved`, `draft`.", "disabled": true } ] }, "description": "Retrieves a list of accessible segmentations for the target instance. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/segmentation.json`\n- **Operation ID:** `getSegmentationUsingGET`\n- **API:** Asset API · Segments\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Segmentations on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/segments/get-segmentations/)\n\n### Parameters\n\n- `status` · query param · string · optional · Allowed values: `approved`, `draft`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfSegmentationResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsegmentationresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "e87f202f-60e3-5ffa-9d43-eb415ac7b069", "name": "GET · Get Segments For Segmentation", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/segmentation/:id/segments.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "segmentation", ":id", "segments.json" ], "query": [ { "key": "status", "value": "", "description": "Status filter for draft or approved versions. Optional, string. Allowed values: `approved`, `draft`.", "disabled": true }, { "key": "offset", "value": "", "description": "Integer offset for paging. Optional, integer (int32).", "disabled": true }, { "key": "maxReturn", "value": "", "description": "Maximum number of records to return. Max 200, default 20. Optional, integer (int32).", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "Retrieves a list of segments inside the target segmentation. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/segmentation/{id}/segments.json`\n- **Operation ID:** `getSegmentsForSegmentationUsingGET`\n- **API:** Asset API · Segments\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Segments For Segmentation on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/segments/get-segments-for-segmentation/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `status` · query param · string · optional · Allowed values: `approved`, `draft`\n- `offset` · query param · integer (int32) · optional\n- `maxReturn` · query param · integer (int32) · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfSegmentsResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsegmentsresponse/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n- `offset`: Integer offset for paging.\n- `maxReturn`: Maximum number of records to return. Max 200, default 20.\n\nAdobe's [Asset API documentation](https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/assets/assets) describes `offset` as the position at which to begin returning results, not a page number. To get the next page, add the `maxReturn` value you used to `offset` and send the request again.\n\nContinue until a response returns no more records. The source specification does not say that a page with fewer than `maxReturn` records is the last one.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } } ] }, { "id": "83b8e69f-5ebc-5605-82d3-07e7d495b813", "name": "Smart Campaigns", "description": "Smart Campaigns operations in the Asset API. Reference: [Smart Campaigns](https://mkto-ref.harrisonjennings.au/reference/asset/smart-campaigns/).", "item": [ { "id": "a87026f3-3141-5778-b8e8-60631bc5ac6f", "name": "GET · Get Smart Campaign by Id", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/smartCampaign/:id.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "smartCampaign", ":id.json" ], "query": [ { "key": "includeFlowSteps", "value": "", "description": "Set to include flow steps in the response. Default true. Optional, boolean.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "Id for the smart campaign. Required, integer (int32)." } ] }, "description": "Returns the smart campaign for the given id. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/smartCampaign/{id}.json`\n- **Operation ID:** `getSmartCampaignByIdUsingGET`\n- **API:** Asset API · Smart Campaigns\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Smart Campaign by Id on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/smart-campaigns/get-smart-campaign-by-id/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `includeFlowSteps` · query param · boolean · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfSmartCampaignResponseWithFlow](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsmartcampaignresponsewithflow/)\n\nDeclared response media type: `application/json`." } }, { "id": "d96d8bf5-540e-52dd-bcfb-979a4812d6dd", "name": "POST · Update Smart Campaign", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/smartCampaign/:id.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "smartCampaign", ":id.json" ], "variable": [ { "key": "id", "value": "", "description": "Id for the smart campaign. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdate the smart campaign for the given id. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/smartCampaign/{id}.json`\n- **Operation ID:** `updateSmartCampaignUsingPOST`\n- **API:** Asset API · Smart Campaigns\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Smart Campaign on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/smart-campaigns/update-smart-campaign/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [UpdateSmartCampaignRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/updatesmartcampaignrequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `description` · string · optional — Description of the smart campaign.\n- `name` · string · optional — Name of the smart campaign.\n\n### Responses\n\n- `200` — OK · [ResponseOfSmartCampaignResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsmartcampaignresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "3d59ce86-2e21-5077-8098-d8b5886cc064", "name": "GET · Get Smart Campaign by Name", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/smartCampaign/byName.json?name=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "smartCampaign", "byName.json" ], "query": [ { "key": "name", "value": "", "description": "Name for the smart campaign. Required, string." }, { "key": "includeFlowSteps", "value": "", "description": "Set to include flow steps in the response. Default true. Optional, boolean.", "disabled": true } ] }, "description": "Returns the smart campaign for the given name. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/smartCampaign/byName.json`\n- **Operation ID:** `getSmartCampaignByNameUsingGET`\n- **API:** Asset API · Smart Campaigns\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Smart Campaign by Name on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/smart-campaigns/get-smart-campaign-by-name/)\n\n### Parameters\n\n- `name` · query param · string · required\n- `includeFlowSteps` · query param · boolean · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfSmartCampaignResponseWithFlow](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsmartcampaignresponsewithflow/)\n\nDeclared response media type: `application/json`." } }, { "id": "87849557-6005-5fe9-bf1d-66d4f229eb75", "name": "GET · Get Smart Campaign Used By", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/smartCampaign/:id/usedBy.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "smartCampaign", ":id", "usedBy.json" ], "query": [ { "key": "offset", "value": "", "description": "Integer offset for paging. Optional, integer (int32).", "disabled": true }, { "key": "maxReturn", "value": "", "description": "Maximum number of results to return. Max 50, default 50. Optional, integer (int32).", "disabled": true }, { "key": "sortByColumn", "value": "", "description": "Column to sort results by. Default updated_at. Optional, string. Allowed values: `updatedAt`, `name`, `updated_at`.", "disabled": true }, { "key": "order", "value": "", "description": "Sort order. Default desc. Optional, string. Allowed values: `asc`, `desc`.", "disabled": true }, { "key": "query", "value": "", "description": "Filter results by name. Optional, string.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "Id of the smart campaign. Required, integer (int32)." } ] }, "description": "Returns a list of assets that reference the specified smart campaign. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/smartCampaign/{id}/usedBy.json`\n- **Operation ID:** `getSmartCampaignUsedByUsingGET`\n- **API:** Asset API · Smart Campaigns\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Smart Campaign Used By on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/smart-campaigns/get-smart-campaign-used-by/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `offset` · query param · integer (int32) · optional\n- `maxReturn` · query param · integer (int32) · optional\n- `sortByColumn` · query param · string · optional · Allowed values: `updatedAt`, `name`, `updated_at`\n- `order` · query param · string · optional · Allowed values: `asc`, `desc`\n- `query` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfSmartCampaignUsedBy](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsmartcampaignusedby/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n- `offset`: Integer offset for paging.\n- `maxReturn`: Maximum number of results to return. Max 50, default 50.\n\nAdobe's [Asset API documentation](https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/assets/assets) describes `offset` as the position at which to begin returning results, not a page number. To get the next page, add the `maxReturn` value you used to `offset` and send the request again.\n\nContinue until a response returns no more records. The source specification does not say that a page with fewer than `maxReturn` records is the last one.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "df32ea9b-025e-5bdd-9329-d7f032e4b96c", "name": "GET · Get Smart Campaign Rules", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/smartCampaign/rules.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "smartCampaign", "rules.json" ] }, "description": "Returns all available trigger and filter rule types that can be used in smart campaign smart lists. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/smartCampaign/rules.json`\n- **Operation ID:** `getSmartCampaignRulesUsingGET`\n- **API:** Asset API · Smart Campaigns\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Smart Campaign Rules on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/smart-campaigns/get-smart-campaign-rules/)\n\n### Responses\n\n- `200` — OK · [ResponseOfSmartCampaignRuleType](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsmartcampaignruletype/)\n\nDeclared response media type: `application/json`." } }, { "id": "022fe58b-a2b2-5701-986b-b2b35b08510c", "name": "GET · Get Smart Campaign Flow Steps", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/smartCampaign/flowSteps.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "smartCampaign", "flowSteps.json" ] }, "description": "Returns all available flow step action types. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/smartCampaign/flowSteps.json`\n- **Operation ID:** `getSmartCampaignFlowStepsUsingGET`\n- **API:** Asset API · Smart Campaigns\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Smart Campaign Flow Steps on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/smart-campaigns/get-smart-campaign-flow-steps/)\n\n### Responses\n\n- `200` — OK · [ResponseOfSmartCampaignFlowStepActionType](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsmartcampaignflowstepactiontype/)\n\nDeclared response media type: `application/json`." } }, { "id": "52270ad1-bbcf-5d45-852a-1204ab596767", "name": "GET · Get Smart Campaign Flow Step Types", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/smartCampaign/flowStepTypes.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "smartCampaign", "flowStepTypes.json" ] }, "description": "Returns flow step types with constraint metadata. These are the subset valid for use as flow step choice conditions. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/smartCampaign/flowStepTypes.json`\n- **Operation ID:** `getSmartCampaignFlowStepTypesUsingGET`\n- **API:** Asset API · Smart Campaigns\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Smart Campaign Flow Step Types on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/smart-campaigns/get-smart-campaign-flow-step-types/)\n\n### Responses\n\n- `200` — OK · [ResponseOfSmartCampaignFlowStepType](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsmartcampaignflowsteptype/)\n\nDeclared response media type: `application/json`." } }, { "id": "d6383fcd-ee89-564b-9e79-3435a8d4cea0", "name": "GET · Get Auto Suggest for Smart Campaign", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/smartCampaign/:id/autoSuggest.json?ruleTypeId=&optionTypeId=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "smartCampaign", ":id", "autoSuggest.json" ], "query": [ { "key": "ruleTypeId", "value": "", "description": "JSON representation of the rule type, with members 'id' and 'type' which may be 'activity' or 'attribute', for example {\"id\":11,\"type\":\"activity\"}. Required, string." }, { "key": "optionTypeId", "value": "", "description": "JSON representation of the constraint, with members 'id' and 'type' which may be 'activity' or 'attribute', for example {\"id\":16,\"type\":\"activity\"}. Required, string." }, { "key": "primaryAttributeValue", "value": "", "description": "Value used to filter suggestions. Optional, string.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "Id of the smart campaign. Required, integer (int32)." } ] }, "description": "Returns suggested values for configuring a flow step choice. Required Permissions: Read-Only Assets\n\n- **Endpoint:** `GET /rest/asset/v1/smartCampaign/{id}/autoSuggest.json`\n- **Operation ID:** `getSmartCampaignAutoSuggestUsingGET`\n- **API:** Asset API · Smart Campaigns\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Auto Suggest for Smart Campaign on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/smart-campaigns/get-auto-suggest-for-smart-campaign/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `ruleTypeId` · query param · string · required\n- `optionTypeId` · query param · string · required\n- `primaryAttributeValue` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfAutoSuggestValue](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofautosuggestvalue/)\n\nDeclared response media type: `application/json`." } }, { "id": "29fb7cb7-edf6-59d5-8f89-88dcb970143d", "name": "POST · Add Flow Step", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "activityType", "value": "", "type": "text", "description": "JSON representation of the flow step type, with members 'id' and 'type', for example {\"id\":6,\"type\":\"activity\"}. Flow step types are returned by Get Smart Campaign Flow Steps. Required, string." }, { "key": "index", "value": "", "type": "text", "description": "0-based position to insert the step. Required, integer (int32)." } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/smartCampaign/:id/flows.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "smartCampaign", ":id", "flows.json" ], "variable": [ { "key": "id", "value": "", "description": "Id of the smart campaign. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request adds records or associations in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nAdds a flow step to a smart campaign. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/smartCampaign/{id}/flows.json`\n- **Operation ID:** `addSmartCampaignFlowStepUsingPOST`\n- **API:** Asset API · Smart Campaigns\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Add Flow Step on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/smart-campaigns/add-flow-step/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n### Responses\n\n- `200` — OK · [ResponseOfSmartCampaignResponseWithFlow](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsmartcampaignresponsewithflow/)\n\nDeclared response media type: `application/json`." } }, { "id": "b1b8bf77-fa51-5510-aa08-1dda33474db3", "name": "POST · Add Step Choice", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/smartCampaign/:id/flow/:stepId/addChoice.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "smartCampaign", ":id", "flow", ":stepId", "addChoice.json" ], "variable": [ { "key": "id", "value": "", "description": "Id of the smart campaign. Required, integer (int32)." }, { "key": "stepId", "value": "", "description": "Id of the flow step. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request adds records or associations in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nAdds a choice to an existing flow step. Use the Update Flow Step Choice endpoint to configure the choice condition and values. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/smartCampaign/{id}/flow/{stepId}/addChoice.json`\n- **Operation ID:** `addSmartCampaignFlowStepChoiceUsingPOST`\n- **API:** Asset API · Smart Campaigns\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Add Step Choice on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/smart-campaigns/add-step-choice/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `stepId` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfSmartCampaignResponseWithFlow](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsmartcampaignresponsewithflow/)\n\nDeclared response media type: `application/json`." } }, { "id": "69d92c9a-dac6-577b-855f-127b7008aa94", "name": "POST · Update Flow Step Choice", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "operator", "value": "", "type": "text", "description": "Condition operator, for example 'is', 'is not', 'contains'. Optional, string.", "disabled": true }, { "key": "conditionTypeId", "value": "", "type": "text", "description": "JSON representation of the attribute tested by the choice condition, with members 'id' and 'type' which may be 'activity' or 'attribute', for example {\"id\":64,\"type\":\"attribute\"}. Applies to non-default choices. Optional, string.", "disabled": true }, { "key": "conditionValues", "value": "", "type": "text", "description": "Comma-separated list of condition values, for example San Francisco,Portland. Optional, string.", "disabled": true }, { "key": "attributes", "value": "", "type": "text", "description": "JSON object mapping attribute ids to values, for example {\"101\":\"1 day\"}. Each key is the activityTypeAttribId of a flow step choice attribute. Optional, string.", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/smartCampaign/:id/flow/:stepId/choice/:choiceId.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "smartCampaign", ":id", "flow", ":stepId", "choice", ":choiceId.json" ], "variable": [ { "key": "id", "value": "", "description": "Id of the smart campaign. Required, integer (int32)." }, { "key": "stepId", "value": "", "description": "Id of the flow step. Required, integer (int32)." }, { "key": "choiceId", "value": "", "description": "Id of the flow step choice. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdates a flow step choice's condition and attribute values. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/smartCampaign/{id}/flow/{stepId}/choice/{choiceId}.json`\n- **Operation ID:** `updateSmartCampaignFlowStepChoiceUsingPOST`\n- **API:** Asset API · Smart Campaigns\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Flow Step Choice on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/smart-campaigns/update-flow-step-choice/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `stepId` · path variable · integer (int32) · required\n- `choiceId` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · optional\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n### Responses\n\n- `200` — OK · [ResponseOfSmartCampaignResponseWithFlow](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsmartcampaignresponsewithflow/)\n\nDeclared response media type: `application/json`." } }, { "id": "bb9c6f4a-d15c-566d-88fe-1424fc3a3811", "name": "POST · Remove Flow Step", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/smartCampaign/:id/flow/:stepId/remove.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "smartCampaign", ":id", "flow", ":stepId", "remove.json" ], "variable": [ { "key": "id", "value": "", "description": "Id of the smart campaign. Required, integer (int32)." }, { "key": "stepId", "value": "", "description": "Id of the flow step. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request removes records or associations in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nRemoves a flow step and all its choices from a smart campaign. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/smartCampaign/{id}/flow/{stepId}/remove.json`\n- **Operation ID:** `removeSmartCampaignFlowStepUsingPOST`\n- **API:** Asset API · Smart Campaigns\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Remove Flow Step on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/smart-campaigns/remove-flow-step/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `stepId` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfSmartCampaignResponseWithFlow](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsmartcampaignresponsewithflow/)\n\nDeclared response media type: `application/json`." } }, { "id": "d95ec528-0954-50c4-8630-7e96879cc666", "name": "POST · Remove Flow Step Choice", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/smartCampaign/:id/flow/:stepId/choice/:choiceId/remove.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "smartCampaign", ":id", "flow", ":stepId", "choice", ":choiceId", "remove.json" ], "variable": [ { "key": "id", "value": "", "description": "Id of the smart campaign. Required, integer (int32)." }, { "key": "stepId", "value": "", "description": "Id of the flow step. Required, integer (int32)." }, { "key": "choiceId", "value": "", "description": "Id of the flow step choice. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request removes records or associations in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nRemoves a specific choice from a flow step. The default choice cannot be removed. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/smartCampaign/{id}/flow/{stepId}/choice/{choiceId}/remove.json`\n- **Operation ID:** `removeSmartCampaignFlowStepChoiceUsingPOST`\n- **API:** Asset API · Smart Campaigns\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Remove Flow Step Choice on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/smart-campaigns/remove-flow-step-choice/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `stepId` · path variable · integer (int32) · required\n- `choiceId` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfSmartCampaignResponseWithFlow](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsmartcampaignresponsewithflow/)\n\nDeclared response media type: `application/json`." } }, { "id": "e722853e-e178-5caa-8b73-7e2d60c2d45e", "name": "POST · Reorder Flow Step Choice", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/smartCampaign/:id/flow/:stepId/choice/:choiceId/reorder.json?newSeqNumZeroBased=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "smartCampaign", ":id", "flow", ":stepId", "choice", ":choiceId", "reorder.json" ], "query": [ { "key": "newSeqNumZeroBased", "value": "", "description": "New 0-based position for the choice. Must be non-negative. Required, integer (int32)." } ], "variable": [ { "key": "id", "value": "", "description": "Id of the smart campaign. Required, integer (int32)." }, { "key": "stepId", "value": "", "description": "Id of the flow step. Required, integer (int32)." }, { "key": "choiceId", "value": "", "description": "Id of the flow step choice. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request changes the order of items in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nMoves a choice to a new position within a flow step. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/smartCampaign/{id}/flow/{stepId}/choice/{choiceId}/reorder.json`\n- **Operation ID:** `reorderSmartCampaignFlowStepChoiceUsingPOST`\n- **API:** Asset API · Smart Campaigns\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Reorder Flow Step Choice on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/smart-campaigns/reorder-flow-step-choice/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `stepId` · path variable · integer (int32) · required\n- `choiceId` · path variable · integer (int32) · required\n- `newSeqNumZeroBased` · query param · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfSmartCampaignResponseWithFlow](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsmartcampaignresponsewithflow/)\n\nDeclared response media type: `application/json`." } }, { "id": "75072c9a-b707-593d-ae21-b05e7bb67dd6", "name": "GET · Get Smart List by Smart Campaign Id", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/smartCampaign/:id/smartList.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "smartCampaign", ":id", "smartList.json" ], "query": [ { "key": "includeRules", "value": "", "description": "Set true to populate smart list rules. Default false. Optional, boolean.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "Id for the smart campaign containing smart list to retrieve. Required, integer (int64)." } ] }, "description": "Retrieves a Smart List record by its Smart Campaign id. Required Permissions: Read-Asset or Read-Write Asset\n\n- **Endpoint:** `GET /rest/asset/v1/smartCampaign/{id}/smartList.json`\n- **Operation ID:** `getSmartListBySmartCampaignIdUsingGET`\n- **API:** Asset API · Smart Campaigns\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Smart List by Smart Campaign Id on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/smart-campaigns/get-smart-list-by-smart-campaign-id/)\n\n### Parameters\n\n- `id` · path variable · integer (int64) · required\n- `includeRules` · query param · boolean · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfSmartListResponseWithRules](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsmartlistresponsewithrules/)\n\nDeclared response media type: `application/json`." } }, { "id": "1bd469ef-4430-5d80-9ba9-5108563b8ecd", "name": "GET · Get Smart Campaigns", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/smartCampaigns.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "smartCampaigns.json" ], "query": [ { "key": "maxReturn", "value": "", "description": "Maximum number of smart campaigns to return. Max 200, default 20. Optional, integer (int32).", "disabled": true }, { "key": "offset", "value": "", "description": "Integer offset for paging. Optional, integer (int32).", "disabled": true }, { "key": "folder", "value": "", "description": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'. Optional, string.", "disabled": true }, { "key": "earliestUpdatedAt", "value": "", "description": "Exclude smart campaigns prior to this date. Must be valid ISO-8601 string. See Datetime (http://developers.marketo.com/rest-api/lead-database/fields/field-types/) field type description. Optional, string.", "disabled": true }, { "key": "latestUpdatedAt", "value": "", "description": "Exclude smart campaigns after this date. Must be valid ISO-8601 string. See Datetime (http://developers.marketo.com/rest-api/lead-database/fields/field-types/) field type description. Optional, string.", "disabled": true }, { "key": "isActive", "value": "", "description": "Set true to return only active campaigns. Default false. Optional, boolean.", "disabled": true } ] }, "description": "Retrieves all smart campaigns. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/smartCampaigns.json`\n- **Operation ID:** `getAllSmartCampaignsGET`\n- **API:** Asset API · Smart Campaigns\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Smart Campaigns on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/smart-campaigns/get-smart-campaigns/)\n\n### Parameters\n\n- `maxReturn` · query param · integer (int32) · optional\n- `offset` · query param · integer (int32) · optional\n- `folder` · query param · string · optional\n- `earliestUpdatedAt` · query param · string · optional\n- `latestUpdatedAt` · query param · string · optional\n- `isActive` · query param · boolean · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfSmartCampaignResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsmartcampaignresponse/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n- `offset`: Integer offset for paging.\n- `maxReturn`: Maximum number of smart campaigns to return. Max 200, default 20.\n\nAdobe's [Asset API documentation](https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/assets/assets) describes `offset` as the position at which to begin returning results, not a page number. To get the next page, add the `maxReturn` value you used to `offset` and send the request again.\n\nContinue until a response returns no more records. The source specification does not say that a page with fewer than `maxReturn` records is the last one.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "d892483b-1c2d-595e-ae07-4a37215170a1", "name": "POST · Create Smart Campaign", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "description", "value": "", "type": "text", "description": "Description of the smart campaign. Optional, string.", "disabled": true }, { "key": "folder", "value": "", "type": "text", "description": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'. Required, Folder. Send the value as JSON text; its properties are listed in the request description." }, { "key": "name", "value": "", "type": "text", "description": "Name of the smart campaign. Required, string." } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/smartCampaigns.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "smartCampaigns.json" ] }, "description": "> **Changes data.** Sending this request creates data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nCreates a new smart campaign. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/smartCampaigns.json`\n- **Operation ID:** `createSmartCampaignUsingPOST`\n- **API:** Asset API · Smart Campaigns\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Create Smart Campaign on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/smart-campaigns/create-smart-campaign/)\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [CreateSmartCampaignRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/createsmartcampaignrequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n**Properties of JSON-valued fields**\n\n- `folder.id` · integer (int32) · required — Id of the folder.\n- `folder.type` · string · required — Type of folder. Allowed values: `Folder`, `Program`.\n\n### Responses\n\n- `200` — OK · [ResponseOfSmartCampaignResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsmartcampaignresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "b02bd6c6-7f28-5055-9ab0-83d2b8ef7572", "name": "POST · Activate Smart Campaign", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/smartCampaign/:id/activate.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "smartCampaign", ":id", "activate.json" ], "variable": [ { "key": "id", "value": "", "description": "Id of the smart campaign. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request activates an asset or rule in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nActivates a trigger smart campaign. Required Permissions: Activate Campaign\n\n- **Endpoint:** `POST /rest/asset/v1/smartCampaign/{id}/activate.json`\n- **Operation ID:** `activateSmartCampaignUsingPOST`\n- **API:** Asset API · Smart Campaigns\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Activate Smart Campaign on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/smart-campaigns/activate-smart-campaign/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "0929e10d-cf07-5e03-acc1-8f9e4231aaca", "name": "POST · Deactivate Smart Campaign", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/smartCampaign/:id/deactivate.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "smartCampaign", ":id", "deactivate.json" ], "variable": [ { "key": "id", "value": "", "description": "Id of the smart campaign. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request deactivates an asset or rule in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDeactivates a trigger smart campaign. Required Permissions: Deactivate Campaign\n\n- **Endpoint:** `POST /rest/asset/v1/smartCampaign/{id}/deactivate.json`\n- **Operation ID:** `deactivateSmartCampaignUsingPOST`\n- **API:** Asset API · Smart Campaigns\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Deactivate Smart Campaign on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/smart-campaigns/deactivate-smart-campaign/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "b1c43367-f717-5435-8659-bbd114d2f8a6", "name": "POST · Clone Smart Campaign", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "description", "value": "", "type": "text", "description": "Description of the smart campaign. Optional, string.", "disabled": true }, { "key": "folder", "value": "", "type": "text", "description": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'. Required, Folder. Send the value as JSON text; its properties are listed in the request description." }, { "key": "name", "value": "", "type": "text", "description": "Name of the smart campaign. Required, string." } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/smartCampaign/:id/clone.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "smartCampaign", ":id", "clone.json" ], "variable": [ { "key": "id", "value": "", "description": "Id of the smart campaign. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request creates a copy of an asset in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nClones a smart campaign. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/smartCampaign/{id}/clone.json`\n- **Operation ID:** `cloneSmartCampaignUsingPOST`\n- **API:** Asset API · Smart Campaigns\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Clone Smart Campaign on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/smart-campaigns/clone-smart-campaign/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [CloneSmartCampaignRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/clonesmartcampaignrequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n**Properties of JSON-valued fields**\n\n- `folder.id` · integer (int32) · required — Id of the folder.\n- `folder.type` · string · required — Type of folder. Allowed values: `Folder`, `Program`.\n\n### Responses\n\n- `200` — OK · [ResponseOfSmartCampaignResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsmartcampaignresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "4b0268a4-d15a-500a-b416-ea5b22705337", "name": "POST · Delete Smart Campaign", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/smartCampaign/:id/delete.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "smartCampaign", ":id", "delete.json" ], "variable": [ { "key": "id", "value": "", "description": "Id of the smart campaign. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDeletes a smart campaign. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/smartCampaign/{id}/delete.json`\n- **Operation ID:** `deleteSmartCampaignUsingPOST`\n- **API:** Asset API · Smart Campaigns\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete Smart Campaign on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/smart-campaigns/delete-smart-campaign/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } } ] }, { "id": "90fa6104-1bc7-5154-be79-a62add5d7e13", "name": "Smart Lists", "description": "Smart Lists operations in the Asset API. Reference: [Smart Lists](https://mkto-ref.harrisonjennings.au/reference/asset/smart-lists/).", "item": [ { "id": "ec47ce7b-a386-5b72-b59f-4a4718228ae5", "name": "GET · Get Smart List by Id", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/smartList/:id.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "smartList", ":id.json" ], "query": [ { "key": "includeRules", "value": "", "description": "Set true to populate smart list rules. Default false. Optional, boolean.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "Id of the smart list to retrieve. Required, integer (int64)." } ] }, "description": "Retrieves a Smart List record by its id. Required Permissions: Read-Asset or Read-Write Asset\n\n- **Endpoint:** `GET /rest/asset/v1/smartList/{id}.json`\n- **Operation ID:** `getSmartListByIdUsingGET`\n- **API:** Asset API · Smart Lists\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Smart List by Id on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/smart-lists/get-smart-list-by-id/)\n\n### Parameters\n\n- `id` · path variable · integer (int64) · required\n- `includeRules` · query param · boolean · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfSmartListResponseWithRules](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsmartlistresponsewithrules/)\n\nDeclared response media type: `application/json`." } }, { "id": "d8a0d9d8-a56f-559f-a570-3c24602382b7", "name": "GET · Get Smart List by Name", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/smartList/byName.json?name=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "smartList", "byName.json" ], "query": [ { "key": "name", "value": "", "description": "Name of smart list to retrieve. Required, string." } ] }, "description": "Retrieves a Smart List record by its name. Required Permissions: Read-Asset or Read-Write Asset\n\n- **Endpoint:** `GET /rest/asset/v1/smartList/byName.json`\n- **Operation ID:** `getSmartListByNameUsingGET`\n- **API:** Asset API · Smart Lists\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Smart List by Name on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/smart-lists/get-smart-list-by-name/)\n\n### Parameters\n\n- `name` · query param · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfSmartListResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsmartlistresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "1e2dbdeb-fde3-591d-b28b-0f95d749619e", "name": "POST · Delete Smart List", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/smartList/:id/delete.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "smartList", ":id", "delete.json" ], "variable": [ { "key": "id", "value": "", "description": "Id of the smart list to delete. Required, integer (int64)." } ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDeletes the designated Smart List. Required Permissions: Read-Write Asset\n\n- **Endpoint:** `POST /rest/asset/v1/smartList/{id}/delete.json`\n- **Operation ID:** `deleteSmartListByIdUsingPOST`\n- **API:** Asset API · Smart Lists\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete Smart List on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/smart-lists/delete-smart-list/)\n\n### Parameters\n\n- `id` · path variable · integer (int64) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "69f2ed36-3ac8-5682-99df-4eff9019591d", "name": "GET · Get Smart Lists", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/smartLists.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "smartLists.json" ], "query": [ { "key": "folder", "value": "", "description": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'. Optional, string.", "disabled": true }, { "key": "offset", "value": "", "description": "Integer offset for paging. Optional, integer (int32).", "disabled": true }, { "key": "maxReturn", "value": "", "description": "Maximum number of smart lists to return. Max 200, default 20. Optional, integer (int32).", "disabled": true }, { "key": "earliestUpdatedAt", "value": "", "description": "Exclude smart lists prior to this date. Must be valid ISO-8601 string. See Datetime (http://developers.marketo.com/rest-api/lead-database/fields/field-types/) field type description. Optional, string.", "disabled": true }, { "key": "latestUpdatedAt", "value": "", "description": "Exclude smart lists after this date. Must be valid ISO-8601 string. See Datetime (http://developers.marketo.com/rest-api/lead-database/fields/field-types/) field type description. Optional, string.", "disabled": true } ] }, "description": "Retrieves a list of user created Smart List records. Required Permissions: Read-Asset or Read-Write Asset\n\n- **Endpoint:** `GET /rest/asset/v1/smartLists.json`\n- **Operation ID:** `getSmartListsUsingGET`\n- **API:** Asset API · Smart Lists\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Smart Lists on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/smart-lists/get-smart-lists/)\n\n### Parameters\n\n- `folder` · query param · string · optional\n- `offset` · query param · integer (int32) · optional\n- `maxReturn` · query param · integer (int32) · optional\n- `earliestUpdatedAt` · query param · string · optional\n- `latestUpdatedAt` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfSmartListResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsmartlistresponse/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n- `offset`: Integer offset for paging.\n- `maxReturn`: Maximum number of smart lists to return. Max 200, default 20.\n\nAdobe's [Asset API documentation](https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/assets/assets) describes `offset` as the position at which to begin returning results, not a page number. To get the next page, add the `maxReturn` value you used to `offset` and send the request again.\n\nContinue until a response returns no more records. The source specification does not say that a page with fewer than `maxReturn` records is the last one.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "7641f2a9-88be-5c1a-ac1c-f8cf55b88800", "name": "POST · Create Smart List", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "name", "value": "", "type": "text", "description": "Name of the smart list. Maximum 255 characters. Required, string." }, { "key": "folder", "value": "", "type": "text", "description": "Folder object describing the parent folder. Required, Folder. Send the value as JSON text; its properties are listed in the request description." }, { "key": "description", "value": "", "type": "text", "description": "Description of the smart list. Maximum 2,000 characters. Optional, string.", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/smartLists.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "smartLists.json" ] }, "description": "> **Changes data.** Sending this request creates data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nCreates a new Smart List. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/smartLists.json`\n- **Operation ID:** `createSmartListUsingPOST`\n- **API:** Asset API · Smart Lists\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Create Smart List on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/smart-lists/create-smart-list/)\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [CreateSmartListRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/createsmartlistrequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n**Properties of JSON-valued fields**\n\n- `folder.id` · integer (int32) · required — Id of the folder.\n- `folder.type` · string · required — Type of folder. Allowed values: `Folder`, `Program`.\n\n### Responses\n\n- `200` — OK · [ResponseOfSmartListResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsmartlistresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "2a1a3e42-69da-5429-b9b3-069475e1eecb", "name": "GET · Get Smart List Rules", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/smartList/rules.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "smartList", "rules.json" ] }, "description": "Returns all available filter rule types that can be used in smart lists. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/smartList/rules.json`\n- **Operation ID:** `getSmartListRulesUsingGET`\n- **API:** Asset API · Smart Lists\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Smart List Rules on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/smart-lists/get-smart-list-rules/)\n\n### Responses\n\n- `200` — OK · [ResponseOfSmartListRuleType](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsmartlistruletype/)\n\nDeclared response media type: `application/json`." } }, { "id": "ab81461d-054f-5fd6-affc-39d1c7640241", "name": "GET · Get Auto Suggest for Smart List", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/smartList/:id/autoSuggest.json?ruleTypeId=&optionTypeId=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "smartList", ":id", "autoSuggest.json" ], "query": [ { "key": "ruleTypeId", "value": "", "description": "JSON representation of the rule type, with members 'id' and 'type' which may be 'activity' or 'attribute', for example {\"id\":11,\"type\":\"activity\"}. Required, string." }, { "key": "optionTypeId", "value": "", "description": "JSON representation of the constraint, with members 'id' and 'type' which may be 'activity' or 'attribute', for example {\"id\":16,\"type\":\"activity\"}. Required, string." }, { "key": "primaryAttributeValue", "value": "", "description": "Value used to filter suggestions. Optional, string.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "Id of the smart list. Required, integer (int64)." } ] }, "description": "Returns suggested values for configuring a smart list rule. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/smartList/{id}/autoSuggest.json`\n- **Operation ID:** `getSmartListAutoSuggestUsingGET`\n- **API:** Asset API · Smart Lists\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Auto Suggest for Smart List on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/smart-lists/get-auto-suggest-for-smart-list/)\n\n### Parameters\n\n- `id` · path variable · integer (int64) · required\n- `ruleTypeId` · query param · string · required\n- `optionTypeId` · query param · string · required\n- `primaryAttributeValue` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfAutoSuggestValue](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofautosuggestvalue/)\n\nDeclared response media type: `application/json`." } }, { "id": "ac2805fb-5955-5a81-84ad-d664f4763124", "name": "POST · Add Rule", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "ruleId", "value": "", "type": "text", "description": "JSON representation of the rule type, with members 'id' and 'type' which may be 'activity' or 'attribute', for example {\"id\":11,\"type\":\"activity\"}. Rule types are returned by Get Smart List Rules. Required, string." }, { "key": "index", "value": "", "type": "text", "description": "1-based position to insert the rule. Required, integer (int32)." }, { "key": "trigger", "value": "", "type": "text", "description": "Set true for a trigger rule. Default false. Optional, boolean.", "disabled": true }, { "key": "negative", "value": "", "type": "text", "description": "Set true to negate the rule. Default false. Optional, boolean.", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/smartList/:id/rules.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "smartList", ":id", "rules.json" ], "variable": [ { "key": "id", "value": "", "description": "Id of the smart list. Required, integer (int64)." } ] }, "description": "> **Changes data.** Sending this request adds records or associations in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nAdds a rule to a smart list. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/smartList/{id}/rules.json`\n- **Operation ID:** `addSmartListRuleUsingPOST`\n- **API:** Asset API · Smart Lists\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Add Rule on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/smart-lists/add-rule/)\n\n### Parameters\n\n- `id` · path variable · integer (int64) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n### Responses\n\n- `200` — OK · [ResponseOfSmartListResponseWithRules](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsmartlistresponsewithrules/)\n\nDeclared response media type: `application/json`." } }, { "id": "4bb591f5-ae47-5fe6-97fc-1dcac5371636", "name": "POST · Update Rule", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "attributeId", "value": "", "type": "text", "description": "JSON representation of the constraint to set, with members 'id' and 'type' which may be 'activity' or 'attribute', for example {\"id\":16,\"type\":\"activity\"}. 'id' is the id of a constraint of the rule type and 'type' is the type of the rule type, both returned by Get Smart List Rules. Required, string." }, { "key": "values", "value": "", "type": "text", "description": "Comma-separated list of values, for example San Francisco,Portland. Enclose a value that contains a comma in double quotes. Required, string." }, { "key": "operator", "value": "", "type": "text", "description": "Comparison operator, for example 'is', 'is not', 'contains', 'starts with'. Optional, string.", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/smartList/:id/rule/:ruleId.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "smartList", ":id", "rule", ":ruleId.json" ], "variable": [ { "key": "id", "value": "", "description": "Id of the smart list. Required, integer (int64)." }, { "key": "ruleId", "value": "", "description": "Id of the rule. Required, integer (int64)." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdates an existing smart list rule. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/smartList/{id}/rule/{ruleId}.json`\n- **Operation ID:** `updateSmartListRuleUsingPOST`\n- **API:** Asset API · Smart Lists\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Rule on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/smart-lists/update-rule/)\n\n### Parameters\n\n- `id` · path variable · integer (int64) · required\n- `ruleId` · path variable · integer (int64) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n### Responses\n\n- `200` — OK · [ResponseOfSmartListResponseWithRules](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsmartlistresponsewithrules/)\n\nDeclared response media type: `application/json`." } }, { "id": "7e3b0a3e-ebb8-5255-b066-0d9a43ea126f", "name": "POST · Update Filter Logic", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "matchType", "value": "", "type": "text", "description": "How rules are combined. Required, string. Allowed values: `all`, `any`, `custom`." }, { "key": "customRuleLogic", "value": "", "type": "text", "description": "Custom logic expression, for example '1 and (2 or 3)'. Required when matchType is custom. Optional, string.", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/smartList/:id/filterLogic.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "smartList", ":id", "filterLogic.json" ], "variable": [ { "key": "id", "value": "", "description": "Id of the smart list. Required, integer (int64)." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdates the filter match type for a smart list. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/smartList/{id}/filterLogic.json`\n- **Operation ID:** `updateSmartListFilterLogicUsingPOST`\n- **API:** Asset API · Smart Lists\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Filter Logic on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/smart-lists/update-filter-logic/)\n\n### Parameters\n\n- `id` · path variable · integer (int64) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n### Responses\n\n- `200` — OK · [ResponseOfSmartListResponseWithRules](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsmartlistresponsewithrules/)\n\nDeclared response media type: `application/json`." } }, { "id": "a28c9ac5-19ec-53ce-9018-787849b6fa59", "name": "POST · Delete Rule", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/smartList/:id/rule/:ruleId/delete.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "smartList", ":id", "rule", ":ruleId", "delete.json" ], "variable": [ { "key": "id", "value": "", "description": "Id of the smart list. Required, integer (int64)." }, { "key": "ruleId", "value": "", "description": "Id of the rule. Required, integer (int64)." } ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDeletes a single rule from a smart list. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/smartList/{id}/rule/{ruleId}/delete.json`\n- **Operation ID:** `deleteSmartListRuleUsingPOST`\n- **API:** Asset API · Smart Lists\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete Rule on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/smart-lists/delete-rule/)\n\n### Parameters\n\n- `id` · path variable · integer (int64) · required\n- `ruleId` · path variable · integer (int64) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "9488cdd8-d4d0-5985-bf9b-a1ca343f081b", "name": "POST · Remove Rule Constraint", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "attributeId", "value": "", "type": "text", "description": "JSON representation of the constraint to remove, with members 'id' and 'type' which may be 'activity' or 'attribute', for example {\"id\":2,\"type\":\"activity\"}. 'id' is the id of a constraint of the rule type and 'type' is the type of the rule type, both returned by Get Smart List Rules. Required, string." } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/smartList/:id/rule/:ruleId/removeConstraint.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "smartList", ":id", "rule", ":ruleId", "removeConstraint.json" ], "variable": [ { "key": "id", "value": "", "description": "Id of the smart list. Required, integer (int64)." }, { "key": "ruleId", "value": "", "description": "Id of the rule. Required, integer (int64)." } ] }, "description": "> **Changes data.** Sending this request removes records or associations in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nRemoves a constraint from a rule without deleting the entire rule. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/smartList/{id}/rule/{ruleId}/removeConstraint.json`\n- **Operation ID:** `removeSmartListRuleConstraintUsingPOST`\n- **API:** Asset API · Smart Lists\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Remove Rule Constraint on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/smart-lists/remove-rule-constraint/)\n\n### Parameters\n\n- `id` · path variable · integer (int64) · required\n- `ruleId` · path variable · integer (int64) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n### Responses\n\n- `200` — OK · [ResponseOfSmartListResponseWithRules](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsmartlistresponsewithrules/)\n\nDeclared response media type: `application/json`." } }, { "id": "6518ece3-7730-5c38-b0b4-6a299f5f4e9d", "name": "POST · Reorder Rules", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "order", "value": "", "type": "text", "description": "JSON array of rules with members 'id' (the rule id) and 'index' (its 1-based position), for example [{\"id\":101,\"index\":1}]. Required, string." } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/smartList/:id/reorder.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "smartList", ":id", "reorder.json" ], "variable": [ { "key": "id", "value": "", "description": "Id of the smart list. Required, integer (int64)." } ] }, "description": "> **Changes data.** Sending this request changes the order of items in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nChanges the order of rules within a smart list. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/smartList/{id}/reorder.json`\n- **Operation ID:** `reorderSmartListRulesUsingPOST`\n- **API:** Asset API · Smart Lists\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Reorder Rules on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/smart-lists/reorder-rules/)\n\n### Parameters\n\n- `id` · path variable · integer (int64) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n### Responses\n\n- `200` — OK · [ResponseOfSmartListResponseWithRules](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsmartlistresponsewithrules/)\n\nDeclared response media type: `application/json`." } }, { "id": "9ca5fcb1-8933-5402-b479-3626914e9ee1", "name": "POST · Delete All Rules", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/smartList/:id/rules/delete.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "smartList", ":id", "rules", "delete.json" ], "variable": [ { "key": "id", "value": "", "description": "Id of the smart list. Required, integer (int64)." } ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nRemoves all rules from a smart list. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/smartList/{id}/rules/delete.json`\n- **Operation ID:** `deleteAllSmartListRulesUsingPOST`\n- **API:** Asset API · Smart Lists\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete All Rules on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/smart-lists/delete-all-rules/)\n\n### Parameters\n\n- `id` · path variable · integer (int64) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfSmartListResponseWithRules](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsmartlistresponsewithrules/)\n\nDeclared response media type: `application/json`." } }, { "id": "4958697e-2ba3-578c-baac-4d57aae7104c", "name": "POST · Clone Smart List", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "name", "value": "", "type": "text", "description": "Name for the cloned smart list. Required, string." }, { "key": "folder", "value": "", "type": "text", "description": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'. Required, Folder. Send the value as JSON text; its properties are listed in the request description." }, { "key": "description", "value": "", "type": "text", "description": "Description of the cloned smart list. Optional, string.", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/smartList/:id/clone.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "smartList", ":id", "clone.json" ], "variable": [ { "key": "id", "value": "", "description": "Id of smart list to clone. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request creates a copy of an asset in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nClones the designated Smart List. Required Permissions: Read-Write Asset\n\n- **Endpoint:** `POST /rest/asset/v1/smartList/{id}/clone.json`\n- **Operation ID:** `cloneSmartListUsingPOST`\n- **API:** Asset API · Smart Lists\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Clone Smart List on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/smart-lists/clone-smart-list/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [CloneSmartListRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/clonesmartlistrequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n**Properties of JSON-valued fields**\n\n- `folder.id` · integer (int32) · required — Id of the folder.\n- `folder.type` · string · required — Type of folder. Allowed values: `Folder`, `Program`.\n\n### Responses\n\n- `200` — OK · [ResponseOfSmartListResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsmartlistresponse/)\n\nDeclared response media type: `application/json`." } } ] }, { "id": "a09d7c5a-7ee0-505d-a3dc-dc854625bfdb", "name": "Snippets", "description": "Snippets operations in the Asset API. Reference: [Snippets](https://mkto-ref.harrisonjennings.au/reference/asset/snippets/).", "item": [ { "id": "018c5fe3-a0ea-50f8-9409-d353d5e1bfeb", "name": "GET · Get Snippet by Id", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/snippet/:id.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "snippet", ":id.json" ], "query": [ { "key": "status", "value": "", "description": "Status filter for draft or approved versions. Optional, string. Allowed values: `approved`, `draft`.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "Retrieves the target snippet record. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/snippet/{id}.json`\n- **Operation ID:** `getSnippetByIdUsingGET`\n- **API:** Asset API · Snippets\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Snippet by Id on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/snippets/get-snippet-by-id/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `status` · query param · string · optional · Allowed values: `approved`, `draft`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfSnippetResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsnippetresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "6c141d68-594c-5033-ab6a-f92a46c0913a", "name": "POST · Update Snippet Metadata", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "description", "value": "", "type": "text", "description": "Description of the snippet. Optional, string.", "disabled": true }, { "key": "isArchive", "value": "", "type": "text", "description": "Archival status of the snippet. Optional, string.", "disabled": true }, { "key": "name", "value": "", "type": "text", "description": "Name of the snippet. Optional, string.", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/snippet/:id.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "snippet", ":id.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdates the metadata of the snippet. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/snippet/{id}.json`\n- **Operation ID:** `updateSnippetUsingPOST`\n- **API:** Asset API · Snippets\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Snippet Metadata on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/snippets/update-snippet-metadata/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [UpdateSnippetRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/updatesnippetrequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n### Responses\n\n- `200` — OK · [ResponseOfSnippetResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsnippetresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "f075acf6-dbd6-573c-8bda-0c9a02173601", "name": "POST · Approve Snippet Draft", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/snippet/:id/approveDraft.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "snippet", ":id", "approveDraft.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request approves an asset in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nApproves the current draft of the snippet. Required Permissions: Approve Assets\n\n- **Endpoint:** `POST /rest/asset/v1/snippet/{id}/approveDraft.json`\n- **Operation ID:** `approveSnippetUsingPOST`\n- **API:** Asset API · Snippets\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Approve Snippet Draft on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/snippets/approve-snippet-draft/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfSnippetResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsnippetresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "39d01935-096a-5514-b0ce-f3633c2809f1", "name": "POST · Clone Snippet", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "name", "value": "", "type": "text", "description": "Name for the cloned snippet. Required, string." }, { "key": "folder", "value": "", "type": "text", "description": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'. Required, Folder. Send the value as JSON text; its properties are listed in the request description." }, { "key": "description", "value": "", "type": "text", "description": "Description of the cloned snippet. Optional, string.", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/snippet/:id/clone.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "snippet", ":id", "clone.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request creates a copy of an asset in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nClones the target snippet. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/snippet/{id}/clone.json`\n- **Operation ID:** `cloneSnippetUsingPOST`\n- **API:** Asset API · Snippets\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Clone Snippet on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/snippets/clone-snippet/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · optional · model [CloneSnippetRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/clonesnippetrequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n**Properties of JSON-valued fields**\n\n- `folder.id` · integer (int32) · required — Id of the folder.\n- `folder.type` · string · required — Type of folder. Allowed values: `Folder`, `Program`.\n\n### Responses\n\n- `200` — OK · [ResponseOfSnippetResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsnippetresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "55ca39fc-3431-5e38-a713-4eb0f1c81c83", "name": "GET · Get Snippet Content", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/snippet/:id/content.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "snippet", ":id", "content.json" ], "query": [ { "key": "status", "value": "", "description": "Status filter for draft or approved versions. Optional, string. Allowed values: `approved`, `draft`.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "Retrieves the content of the target snippet. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/snippet/{id}/content.json`\n- **Operation ID:** `getSnippetContentByIdUsingGET`\n- **API:** Asset API · Snippets\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Snippet Content on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/snippets/get-snippet-content/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `status` · query param · string · optional · Allowed values: `approved`, `draft`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfSnippetContentResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsnippetcontentresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "a33e2f91-eca5-534d-b65e-f3142e39f70b", "name": "POST · Update Snippet Content", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/snippet/:id/content.json?content=&type=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "snippet", ":id", "content.json" ], "query": [ { "key": "content", "value": "", "description": "Content of the snippet. Required, string." }, { "key": "type", "value": "", "description": "Type of snippet content. Required, string. Allowed values: `DynamicContent`, `HTML`, `Text`." } ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdates the content of the target snippet. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/snippet/{id}/content.json`\n- **Operation ID:** `updateContentUsingPOST_1`\n- **API:** Asset API · Snippets\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Snippet Content on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/snippets/update-snippet-content/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `content` · query param · string · required\n- `type` · query param · string · required · Allowed values: `DynamicContent`, `HTML`, `Text`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "eb73b829-8f34-5c7a-b76f-5e2883b6fdfd", "name": "POST · Delete Snippet", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/snippet/:id/delete.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "snippet", ":id", "delete.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDeletes the target snippet. The snippet may not be in use by emails or landing pages. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/snippet/{id}/delete.json`\n- **Operation ID:** `deleteSnippetUsingPOST`\n- **API:** Asset API · Snippets\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete Snippet on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/snippets/delete-snippet/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "9ed43c89-d03c-50c1-be73-28f0fd2a1f0a", "name": "POST · Discard Snippet Draft", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/snippet/:id/discardDraft.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "snippet", ":id", "discardDraft.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request discards a draft in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDiscards the current draft of the snippet. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/snippet/{id}/discardDraft.json`\n- **Operation ID:** `discardSnippetUsingPOST`\n- **API:** Asset API · Snippets\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Discard Snippet Draft on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/snippets/discard-snippet-draft/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "4fc3902a-991d-51b9-8b81-897fa8e69b3b", "name": "GET · Get Dynamic Content", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/snippet/:id/dynamicContent.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "snippet", ":id", "dynamicContent.json" ], "query": [ { "key": "status", "value": "", "description": "Status filter for draft or approved versions. Optional, string. Allowed values: `approved`, `draft`.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "Gets the list of dynamic content sections for the snippet. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/snippet/{id}/dynamicContent.json`\n- **Operation ID:** `getDynamicContentUsingGET`\n- **API:** Asset API · Snippets\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Dynamic Content on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/snippets/get-dynamic-content/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `status` · query param · string · optional · Allowed values: `approved`, `draft`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ModelResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/modelresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "ac720a05-5399-5725-920e-83041066d2d3", "name": "POST · Update Snippet Dynamic Content", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "type", "value": "Typeofcontent.Either'HTML'or'Text'", "type": "text", "description": "Type of dynamic content section. Optional, string. Allowed values: `Typeofcontent.Either'HTML'or'Text'`.", "disabled": true }, { "key": "value", "value": "", "type": "text", "description": "Value of the dynamic content section. Optional, string.", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/snippet/:id/dynamicContent/:segmentId.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "snippet", ":id", "dynamicContent", ":segmentId.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." }, { "key": "segmentId", "value": "", "description": "segmentId. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdates the target dynamic content section. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/snippet/{id}/dynamicContent/{segmentId}.json`\n- **Operation ID:** `updateDynamicContentUsingPOST`\n- **API:** Asset API · Snippets\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Snippet Dynamic Content on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/snippets/update-snippet-dynamic-content/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `segmentId` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [UpdateSnippetDynamicContentRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/updatesnippetdynamiccontentrequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "730e35ce-e3e0-523a-a6b3-037f216f016e", "name": "POST · Unapprove Snippet", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/snippet/:id/unapprove.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "snippet", ":id", "unapprove.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request unapproves an asset in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUnapproves 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\n\n- **Endpoint:** `POST /rest/asset/v1/snippet/{id}/unapprove.json`\n- **Operation ID:** `unapproveSnippetUsingPOST`\n- **API:** Asset API · Snippets\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Unapprove Snippet on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/snippets/unapprove-snippet/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfSnippetResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsnippetresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "c38a3bfb-b629-5f45-acb0-a8dfd824e141", "name": "GET · Get Snippets", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/snippets.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "snippets.json" ], "query": [ { "key": "status", "value": "", "description": "Status filter for draft or approved versions. Optional, string. Allowed values: `approved`, `draft`.", "disabled": true }, { "key": "maxReturn", "value": "", "description": "Maximum number of records to return. Max 200, default 20. Optional, integer (int32).", "disabled": true }, { "key": "offset", "value": "", "description": "Integer offset for paging. Optional, integer (int32).", "disabled": true } ] }, "description": "Retrieves a list of accessible snippets from the target instance. Required Permissions: Read-Only Assets, Read-Write Assets.\n\nNote: Fragments created with the new email designer may appear in this API's response, but some of the fields may be null or incomplete. For complete and reliable details of these assets, use the Fragments (New) APIs; refer to the [List Fragments](https://developer.adobe.com/marketo-apis/api/asset#operation/filterContentUsingGET_fragment) endpoint.\n\n- **Endpoint:** `GET /rest/asset/v1/snippets.json`\n- **Operation ID:** `getSnippetUsingGET`\n- **API:** Asset API · Snippets\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Snippets on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/snippets/get-snippets/)\n\n### Parameters\n\n- `status` · query param · string · optional · Allowed values: `approved`, `draft`\n- `maxReturn` · query param · integer (int32) · optional\n- `offset` · query param · integer (int32) · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfSnippetResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsnippetresponse/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n- `offset`: Integer offset for paging.\n- `maxReturn`: Maximum number of records to return. Max 200, default 20.\n\nAdobe's [Asset API documentation](https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/assets/assets) describes `offset` as the position at which to begin returning results, not a page number. To get the next page, add the `maxReturn` value you used to `offset` and send the request again.\n\nContinue until a response returns no more records. The source specification does not say that a page with fewer than `maxReturn` records is the last one.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "70f28c7e-262d-5a15-8bef-9b21667b4f68", "name": "POST · Create Snippet", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "description", "value": "", "type": "text", "description": "Description of the snippet. Optional, string.", "disabled": true }, { "key": "folder", "value": "", "type": "text", "description": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'. Required, Folder. Send the value as JSON text; its properties are listed in the request description." }, { "key": "name", "value": "", "type": "text", "description": "Name of the snippet. Required, string." } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/snippets.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "snippets.json" ] }, "description": "> **Changes data.** Sending this request creates data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nCreates a new snippet. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/snippets.json`\n- **Operation ID:** `createSnippetUsingPOST`\n- **API:** Asset API · Snippets\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Create Snippet on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/snippets/create-snippet/)\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [CreateSnippetRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/createsnippetrequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n**Properties of JSON-valued fields**\n\n- `folder.id` · integer (int32) · required — Id of the folder.\n- `folder.type` · string · required — Type of folder. Allowed values: `Folder`, `Program`.\n\n### Responses\n\n- `200` — OK · [ResponseOfSnippetResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofsnippetresponse/)\n\nDeclared response media type: `application/json`." } } ] }, { "id": "feecf304-fb18-5b26-bfc7-f5ca8e123256", "name": "Static Lists", "description": "Static Lists operations in the Asset API. Reference: [Static Lists](https://mkto-ref.harrisonjennings.au/reference/asset/static-lists/).", "item": [ { "id": "dc01add3-ca9f-5f25-9442-5df6fe841ae1", "name": "GET · Get Static List by Id", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/staticList/:id.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "staticList", ":id.json" ], "variable": [ { "key": "id", "value": "", "description": "Id of the static list to retrieve. Required, integer (int64)." } ] }, "description": "Retrieves a Static List record by its id. Required Permissions: Read-Asset or Read-Write Asset\n\n- **Endpoint:** `GET /rest/asset/v1/staticList/{id}.json`\n- **Operation ID:** `getStaticListByIdUsingGET`\n- **API:** Asset API · Static Lists\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Static List by Id on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/static-lists/get-static-list-by-id/)\n\n### Parameters\n\n- `id` · path variable · integer (int64) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfStaticListResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofstaticlistresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "520466c5-a82a-5135-9013-23787dace35c", "name": "POST · Update Static List Metadata", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "description", "value": "", "type": "text", "description": "Description of the static list. Optional, string.", "disabled": true }, { "key": "name", "value": "", "type": "text", "description": "Name of the static list. Optional, string.", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/staticList/:id.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "staticList", ":id.json" ], "variable": [ { "key": "id", "value": "", "description": "Id of static list to update. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdates the metadata of a static list asset. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/staticList/{id}.json`\n- **Operation ID:** `updateStaticListUsingPOST`\n- **API:** Asset API · Static Lists\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Static List Metadata on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/static-lists/update-static-list-metadata/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [UpdateStaticListRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/updatestaticlistrequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n### Responses\n\n- `200` — OK · [ResponseOfStaticListResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofstaticlistresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "40a6bff8-2db7-5408-a96e-94a37d5d7156", "name": "GET · Get Static Lists", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/staticLists.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "staticLists.json" ], "query": [ { "key": "folder", "value": "", "description": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'. Optional, string.", "disabled": true }, { "key": "offset", "value": "", "description": "Integer offset for paging. Optional, integer (int32).", "disabled": true }, { "key": "maxReturn", "value": "", "description": "Maximum number of static lists to return. Max 200, default 20. Optional, integer (int32).", "disabled": true }, { "key": "earliestUpdatedAt", "value": "", "description": "Exclude static lists prior to this date. Must be valid ISO-8601 string. See Datetime (http://developers.marketo.com/rest-api/lead-database/fields/field-types/) field type description. Optional, string.", "disabled": true }, { "key": "latestUpdatedAt", "value": "", "description": "Exclude static lists after this date. Must be valid ISO-8601 string. See Datetime (http://developers.marketo.com/rest-api/lead-database/fields/field-types/) field type description. Optional, string.", "disabled": true } ] }, "description": "Retrieves a list of Static List records. Required Permissions: Read-Asset or Read-Write Asset\n\n- **Endpoint:** `GET /rest/asset/v1/staticLists.json`\n- **Operation ID:** `getStaticListsUsingGET`\n- **API:** Asset API · Static Lists\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Static Lists on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/static-lists/get-static-lists/)\n\n### Parameters\n\n- `folder` · query param · string · optional\n- `offset` · query param · integer (int32) · optional\n- `maxReturn` · query param · integer (int32) · optional\n- `earliestUpdatedAt` · query param · string · optional\n- `latestUpdatedAt` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfStaticListResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofstaticlistresponse/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n- `offset`: Integer offset for paging.\n- `maxReturn`: Maximum number of static lists to return. Max 200, default 20.\n\nAdobe's [Asset API documentation](https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/assets/assets) describes `offset` as the position at which to begin returning results, not a page number. To get the next page, add the `maxReturn` value you used to `offset` and send the request again.\n\nContinue until a response returns no more records. The source specification does not say that a page with fewer than `maxReturn` records is the last one.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "048f8e24-9be1-5677-b814-64821906d9ac", "name": "POST · Create Static List", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "description", "value": "", "type": "text", "description": "Description of the static list. Optional, string.", "disabled": true }, { "key": "name", "value": "", "type": "text", "description": "Name of the static list. Required, string." }, { "key": "folder", "value": "", "type": "text", "description": "Folder object describing the parent folder. Required, Folder. Send the value as JSON text; its properties are listed in the request description." } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/staticLists.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "staticLists.json" ] }, "description": "> **Changes data.** Sending this request creates data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nCreates a new Static List. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/staticLists.json`\n- **Operation ID:** `createStaticListUsingPOST`\n- **API:** Asset API · Static Lists\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Create Static List on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/static-lists/create-static-list/)\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [CreateStaticListRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/createstaticlistrequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n**Properties of JSON-valued fields**\n\n- `folder.id` · integer (int32) · required — Id of the folder.\n- `folder.type` · string · required — Type of folder. Allowed values: `Folder`, `Program`.\n\n### Responses\n\n- `200` — OK · [ResponseOfStaticListResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofstaticlistresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "9367e2b4-b4fc-58a6-9347-d120e9a40193", "name": "GET · Get Static List by Name", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/staticList/byName.json?name=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "staticList", "byName.json" ], "query": [ { "key": "name", "value": "", "description": "Name of static list to retrieve. Required, string." } ] }, "description": "Retrieves a Static List record by its name. Required Permissions: Read-Asset or Read-Write Asset\n\n- **Endpoint:** `GET /rest/asset/v1/staticList/byName.json`\n- **Operation ID:** `getStaticListByNameUsingGET`\n- **API:** Asset API · Static Lists\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Static List by Name on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/static-lists/get-static-list-by-name/)\n\n### Parameters\n\n- `name` · query param · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfStaticListResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofstaticlistresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "0c1dc7e5-bb00-54fd-9668-6d8f913c70c1", "name": "POST · Delete Static List", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/staticList/:id/delete.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "staticList", ":id", "delete.json" ], "variable": [ { "key": "id", "value": "", "description": "Id of the static list to delete. Required, integer (int64)." } ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDeletes the designated Static List. Required Permissions: Read-Write Asset\n\n- **Endpoint:** `POST /rest/asset/v1/staticList/{id}/delete.json`\n- **Operation ID:** `deleteStaticListByIdUsingPOST`\n- **API:** Asset API · Static Lists\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete Static List on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/static-lists/delete-static-list/)\n\n### Parameters\n\n- `id` · path variable · integer (int64) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } } ] }, { "id": "70475434-84e2-5288-8c1a-143784f6e029", "name": "Tags", "description": "Tags operations in the Asset API. Reference: [Tags](https://mkto-ref.harrisonjennings.au/reference/asset/tags/).", "item": [ { "id": "41f3f5d2-cd77-502d-9551-07148b4c79af", "name": "GET · Get Tag By Name", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/tagType/byName.json?name=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "tagType", "byName.json" ], "query": [ { "key": "name", "value": "", "description": "Name of the tag. Required, string." } ] }, "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\n\n- **Endpoint:** `GET /rest/asset/v1/tagType/byName.json`\n- **Operation ID:** `getTagByNameUsingGET`\n- **API:** Asset API · Tags\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Tag By Name on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/tags/get-tag-by-name/)\n\n### Parameters\n\n- `name` · query param · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfTagResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoftagresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "a7813ff8-49e2-54a4-b149-2a61bacdeb0f", "name": "GET · Get Tag Types", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/tagTypes.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "tagTypes.json" ], "query": [ { "key": "maxReturn", "value": "", "description": "Maximum number of records to return. Max 200, default 20. Optional, integer (int32).", "disabled": true }, { "key": "offset", "value": "", "description": "Integer offset for paging. Optional, integer (int32).", "disabled": true } ] }, "description": "Retrieves a list of available tag types. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/tagTypes.json`\n- **Operation ID:** `getTagTypesUsingGET`\n- **API:** Asset API · Tags\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Tag Types on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/tags/get-tag-types/)\n\n### Parameters\n\n- `maxReturn` · query param · integer (int32) · optional\n- `offset` · query param · integer (int32) · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfTagResponseGetAll](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoftagresponsegetall/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n- `offset`: Integer offset for paging.\n- `maxReturn`: Maximum number of records to return. Max 200, default 20.\n\nAdobe's [Asset API documentation](https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/assets/assets) describes `offset` as the position at which to begin returning results, not a page number. To get the next page, add the `maxReturn` value you used to `offset` and send the request again.\n\nContinue until a response returns no more records. The source specification does not say that a page with fewer than `maxReturn` records is the last one.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } } ] }, { "id": "bd926f49-1d62-5cfe-a070-23b6bf61e26b", "name": "Tokens", "description": "Tokens operations in the Asset API. Reference: [Tokens](https://mkto-ref.harrisonjennings.au/reference/asset/tokens/).", "item": [ { "id": "132950fb-65ee-54e6-bdd6-48df06bb5853", "name": "GET · Get Tokens by Folder Id", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/folder/:id/tokens.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "folder", ":id", "tokens.json" ], "query": [ { "key": "folderType", "value": "Folder", "description": "Type of folder. 'Folder' or 'Program'. Optional, string. Allowed values: `Folder`, `Program`. Default: `Folder`.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "Retrieves the list of available My Tokens in the target folder. Required Permissions: Read-Only Assets, Read-Write Assets\n\n- **Endpoint:** `GET /rest/asset/v1/folder/{id}/tokens.json`\n- **Operation ID:** `getTokensByFolderIdUsingGET`\n- **API:** Asset API · Tokens\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Tokens by Folder Id on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/tokens/get-tokens-by-folder-id/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n- `folderType` · query param · string · optional · Allowed values: `Folder`, `Program` · Default: `Folder`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfTokenResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoftokenresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "c3b1ba71-b163-5382-90f7-bf9041115036", "name": "POST · Create Token", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "folderType", "value": "", "type": "text", "description": "Type of folder. 'Folder' or 'Program'. Required, string. Allowed values: `Program`, `Folder`." }, { "key": "name", "value": "", "type": "text", "description": "Name of the token. Max length is 50 characters) Required, string." }, { "key": "type", "value": "", "type": "text", "description": "Type of the token. Required, string. Allowed values: `date`, `number`, `rich text`, `score`, `sfdc campaign`, `text`." }, { "key": "value", "value": "", "type": "text", "description": "Value of the token. Required, string." } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/folder/:id/tokens.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "folder", ":id", "tokens.json" ], "variable": [ { "key": "id", "value": "", "description": "Id of the folder to which the token will be associated with. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request creates data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nCreate or update a token in the parent folder. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/folder/{id}/tokens.json`\n- **Operation ID:** `addTokenTOFolderUsingPOST`\n- **API:** Asset API · Tokens\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Create Token on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/tokens/create-token/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [CreateTokenRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/createtokenrequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n### Responses\n\n- `200` — OK · [ResponseOfTokenResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseoftokenresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "6a634927-f8c3-5ee5-8819-15f6bdea518c", "name": "POST · Delete Token by Name", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "folderType", "value": "", "type": "text", "description": "Not documented in the source specification. Optional, string. Allowed values: `Program`, `Folder`.", "disabled": true }, { "key": "name", "value": "", "type": "text", "description": "Not documented in the source specification. Optional, string.", "disabled": true }, { "key": "type", "value": "", "type": "text", "description": "Not documented in the source specification. Optional, string.", "disabled": true } ] }, "url": { "raw": "{{marketoBaseUrl}}/rest/asset/v1/folder/:id/tokens/delete.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "asset", "v1", "folder", ":id", "tokens", "delete.json" ], "variable": [ { "key": "id", "value": "", "description": "id. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDeletes a token with the given name from the parent folder. Required Permissions: Read-Write Assets\n\n- **Endpoint:** `POST /rest/asset/v1/folder/{id}/tokens/delete.json`\n- **Operation ID:** `deleteTokenByNameUsingPOST`\n- **API:** Asset API · Tokens\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete Token by Name on the documentation site](https://mkto-ref.harrisonjennings.au/reference/asset/tokens/delete-token-by-name/)\n\n### Parameters\n\n- `id` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/x-www-form-urlencoded` · required · model [DeleteTokenRequest](https://mkto-ref.harrisonjennings.au/reference/asset/models/deletetokenrequest/)\n\nEach form field is a row in the **Body** tab (x-www-form-urlencoded), with its description. Required fields are enabled; optional fields are disabled until you enable them.\n\n### Responses\n\n- `200` — OK · [ResponseOfIdResponse](https://mkto-ref.harrisonjennings.au/reference/asset/models/responseofidresponse/)\n\nDeclared response media type: `application/json`." } } ] } ] }, { "id": "a0c42d4f-c984-59ed-9c9c-6379caecd1d3", "name": "Core API", "description": "Leads, activities, campaigns, companies, custom objects, opportunities, lists, bulk import and export jobs, and usage.\n\n- **Base URL:** `{{marketoBaseUrl}}`\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Core API on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/)\n\nRequests run only when you send them, or when you select them for a Postman run.", "item": [ { "id": "94d8aef2-af42-5d92-a0fb-6205bedac036", "name": "Activities", "description": "Activities operations in the Core API. Reference: [Activities](https://mkto-ref.harrisonjennings.au/reference/core/activities/).", "item": [ { "id": "98c47caa-0cac-5f00-b765-1a37f4d9112a", "name": "GET · Get Lead Activities", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/activities.json?nextPageToken=&activityTypeIds=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "activities.json" ], "query": [ { "key": "nextPageToken", "value": "", "description": "Token representation of a datetime returned by the Get Paging Token endpoint. This endpoint will return activities after this datetime. Required, string." }, { "key": "activityTypeIds", "value": "", "description": "Comma-separated list of activity type ids. These can be retrieved with the Get Activity Types API. Required, array of integer (int32). Comma-separated list in a single value, e.g. a,b,c." }, { "key": "assetIds", "value": "", "description": "Id of the primary asset for an activity. This is based on the primary asset id of a given activity type. Should only be used when a single activity type is set. Optional, array of integer (int32). Comma-separated list in a single value, e.g. a,b,c.", "disabled": true }, { "key": "listId", "value": "", "description": "Id of a static list. If set, will only return activities of members of this static list. Optional, integer (int32).", "disabled": true }, { "key": "leadIds", "value": "", "description": "Comma-separated list of lead ids. If set, will only return activities of the leads with these ids. Allows up to 30 entries. Optional, array of integer (int64). Comma-separated list in a single value, e.g. a,b,c.", "disabled": true }, { "key": "batchSize", "value": "", "description": "Maximum number of records to return. Maximum and default is 300. Optional, integer (int32).", "disabled": true } ] }, "description": "Returns a list of activities from after a datetime given by the `nextPageToken` parameter. Also allows for filtering by lead static list membership, or by a list of up to 30 lead ids. Beginning 2026-09-30, calls to the `Get Lead Activities` and `Get Lead Changes` endpoints which includes the `listId` parameter will fail (error code 1003) if the target lists contain 10,000 or more leads. To avoid service disruptions, ensure that calls are properly scoped to avoid this limit. Required Permissions: Read-Only Activity, Read-Write Activity\n\n- **Endpoint:** `GET /rest/v1/activities.json`\n- **Operation ID:** `getLeadActivitiesUsingGET`\n- **API:** Core API · Activities\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Lead Activities on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/activities/get-lead-activities/)\n\n### Parameters\n\n- `nextPageToken` · query param · string · required\n- `activityTypeIds` · query param · array of integer (int32) · required\n- `assetIds` · query param · array of integer (int32) · optional\n- `listId` · query param · integer (int32) · optional\n- `leadIds` · query param · array of integer (int64) · optional\n- `batchSize` · query param · integer (int32) · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfActivity](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofactivity/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n1. Send `GET · Get Paging Token` first, and copy the `nextPageToken` from its response into this request's `nextPageToken` param.\n2. Send this request. If the response has `moreResult` set to `true`, copy the `nextPageToken` from the response into the `nextPageToken` param, and send the request again.\n3. Stop when `moreResult` is `false`.\n4. `batchSize` sets the maximum number of records per response.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "999e7576-3391-545d-8366-0da4f0e896dd", "name": "GET · Get Deleted Leads", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/activities/deletedleads.json?nextPageToken=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "activities", "deletedleads.json" ], "query": [ { "key": "nextPageToken", "value": "", "description": "Token representation of a datetime returned by the Get Paging Token endpoint. This endpoint will return activities after this datetime. Required, string." }, { "key": "batchSize", "value": "", "description": "Maximum number of records to return. Maximum and default is 300. Optional, integer (int32).", "disabled": true } ] }, "description": "Returns a list of leads deleted after a given datetime. Deletions greater than 14 days old may be pruned. Required Permissions: Read-Only Activity, Read-Write Activity\n\n- **Endpoint:** `GET /rest/v1/activities/deletedleads.json`\n- **Operation ID:** `getDeletedLeadsUsingGET`\n- **API:** Core API · Activities\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Deleted Leads on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/activities/get-deleted-leads/)\n\n### Parameters\n\n- `nextPageToken` · query param · string · required\n- `batchSize` · query param · integer (int32) · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfActivity](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofactivity/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n1. Send `GET · Get Paging Token` first, and copy the `nextPageToken` from its response into this request's `nextPageToken` param.\n2. Send this request. If the response has `moreResult` set to `true`, copy the `nextPageToken` from the response into the `nextPageToken` param, and send the request again.\n3. Stop when `moreResult` is `false`.\n4. `batchSize` sets the maximum number of records per response.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "104175f9-0baf-5464-b642-7b3b7a672359", "name": "POST · Add Custom Activities", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"activityDate\": null,\n \"activityTypeId\": null,\n \"attributes\": [\n {\n \"name\": null,\n \"value\": {}\n }\n ],\n \"errors\": [\n {\n \"code\": null,\n \"message\": null\n }\n ],\n \"id\": null,\n \"leadId\": null,\n \"primaryAttributeValue\": null\n }\n ]\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/activities/external.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "activities", "external.json" ] }, "description": "> **Changes data.** Sending this request adds records or associations in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nAllows insertion of custom activities associated to given lead records. Requires provisioning of custom activity types to utilize. Required Permissions: Read-Write Activity\n\n- **Endpoint:** `POST /rest/v1/activities/external.json`\n- **Operation ID:** `addCustomActivityUsingPOST`\n- **API:** Core API · Activities\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Add Custom Activities on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/activities/add-custom-activities/)\n\n### Request body\n\n`application/json` · required · model [CustomActivityRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/customactivityrequest/)\n\nThe body starts with the required properties only, set to `null`. Replace each `null` with a value, and add any optional properties you need.\n\n**Properties**\n\n- `input` · array of CustomActivity · required — List of custom activities to insert.\n- `input[].activityDate` · string · required — Datetime of the activity.\n- `input[].activityTypeId` · integer (int32) · required — Id of the activity type.\n- `input[].apiName` · string · optional — Not documented in the source specification.\n- `input[].attributes` · array of Attribute · required — List of secondary attributes.\n- `input[].attributes[].apiName` · string · optional — Not documented in the source specification.\n- `input[].attributes[].name` · string · required — Name of the attribute.\n- `input[].attributes[].value` · object · required — Value of the attribute.\n- `input[].errors` · array of Error · required — Array of errors that occurred if the request was unsuccessful.\n- `input[].errors[].code` · string · required — Error code of the error. See full list of error codes [here](https://developers.marketo.com/rest-api/error-codes/)\n- `input[].errors[].message` · string · required — Message describing the cause of the error.\n- `input[].id` · integer (int64) · required — Integer id of the activity. For instances which have been migrated to Activity Service, this field may not be present, and should not be treated as unique.\n- `input[].leadId` · integer (int64) · required — Id of the lead associated to the activity.\n- `input[].marketoGUID` · string · optional — Unique id of the activity (128 character string)\n- `input[].primaryAttributeValue` · string · required — Value of the primary attribute.\n- `input[].status` · string · optional — Status of the operation performed on the record. Allowed values: `created`, `updated`, `deleted`, `skipped`, `added`, `removed`.\n\n### Responses\n\n- `200` — OK · [ResponseOfCustomActivity](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofcustomactivity/)\n\nDeclared response media type: `application/json`." } }, { "id": "4d891499-a48b-5c7d-bd85-596e6673116d", "name": "POST · Create Custom Activity Type", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"apiName\": null,\n \"filterName\": null,\n \"name\": null,\n \"primaryAttribute\": {\n \"apiName\": null,\n \"name\": null\n },\n \"triggerName\": null\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/activities/external/type.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "activities", "external", "type.json" ] }, "description": "> **Changes data.** Sending this request creates data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nCreates a new custom activity type draft in the target instance. Required Permissions: Read-Write Activity Metadata\n\n- **Endpoint:** `POST /rest/v1/activities/external/type.json`\n- **Operation ID:** `createCustomActivityTypeUsingPOST`\n- **API:** Core API · Activities\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Create Custom Activity Type on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/activities/create-custom-activity-type/)\n\n### Request body\n\n`application/json` · required · model [CustomActivityTypeRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/customactivitytyperequest/)\n\nThe body starts with the required properties only, set to `null`. Replace each `null` with a value, and add any optional properties you need.\n\n**Properties**\n\n- `apiName` · string · required — Not documented in the source specification.\n- `description` · string · optional — Not documented in the source specification.\n- `filterName` · string · required — Human-readable name of the associated filter.\n- `name` · string · required — Human-readable display name of the activity type.\n- `primaryAttribute` · CustomActivityTypeAttribute · required — Primary attribute of the activity type.\n- `primaryAttribute.apiName` · string · required — API Name of the attribute.\n- `primaryAttribute.dataType` · string · optional — Data type of the attribute. Allowed values: `string`, `boolean`, `integer`, `float`, `link`, `email`, `currency`, `date`, `datetime`, `phone`, `text`.\n- `primaryAttribute.description` · string · optional — Description of the attribute.\n- `primaryAttribute.isPrimary` · boolean · optional — Whether the attribute is the primary attribute of the activity type. There may only be one primary attribute at a time.\n- `primaryAttribute.name` · string · required — Human-readable display name of the attribute.\n- `triggerName` · string · required — Human-readable name of the associated trigger.\n\n### Responses\n\n- `200` — OK · [ResponseOfCustomActivityType](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofcustomactivitytype/)\n\nDeclared response media type: `application/json`." } }, { "id": "eafb5777-0d6f-53b9-90af-5db73af70972", "name": "POST · Update Custom Activity Type", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"apiName\": null,\n \"filterName\": null,\n \"name\": null,\n \"primaryAttribute\": {\n \"apiName\": null,\n \"name\": null\n },\n \"triggerName\": null\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/activities/external/type/:apiName.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "activities", "external", "type", ":apiName.json" ], "variable": [ { "key": "apiName", "value": "", "description": "API Name of the activity type. Required, string." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdates the target custom activity type. All changes are applied to the draft version of the type. Required Permissions: Read-Write Activity Metadata\n\n- **Endpoint:** `POST /rest/v1/activities/external/type/{apiName}.json`\n- **Operation ID:** `updateCustomActivityTypeUsingPOST`\n- **API:** Core API · Activities\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Custom Activity Type on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/activities/update-custom-activity-type/)\n\n### Parameters\n\n- `apiName` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [CustomActivityTypeRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/customactivitytyperequest/)\n\nThe body starts with the required properties only, set to `null`. Replace each `null` with a value, and add any optional properties you need.\n\n**Properties**\n\n- `apiName` · string · required — Not documented in the source specification.\n- `description` · string · optional — Not documented in the source specification.\n- `filterName` · string · required — Human-readable name of the associated filter.\n- `name` · string · required — Human-readable display name of the activity type.\n- `primaryAttribute` · CustomActivityTypeAttribute · required — Primary attribute of the activity type.\n- `primaryAttribute.apiName` · string · required — API Name of the attribute.\n- `primaryAttribute.dataType` · string · optional — Data type of the attribute. Allowed values: `string`, `boolean`, `integer`, `float`, `link`, `email`, `currency`, `date`, `datetime`, `phone`, `text`.\n- `primaryAttribute.description` · string · optional — Description of the attribute.\n- `primaryAttribute.isPrimary` · boolean · optional — Whether the attribute is the primary attribute of the activity type. There may only be one primary attribute at a time.\n- `primaryAttribute.name` · string · required — Human-readable display name of the attribute.\n- `triggerName` · string · required — Human-readable name of the associated trigger.\n\n### Responses\n\n- `200` — OK · [ResponseOfCustomActivityType](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofcustomactivitytype/)\n\nDeclared response media type: `application/json`." } }, { "id": "ee80dbbe-f758-5ae6-92ad-c9cce1319327", "name": "POST · Approve Custom Activity Type", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/activities/external/type/:apiName/approve.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "activities", "external", "type", ":apiName", "approve.json" ], "variable": [ { "key": "apiName", "value": "", "description": "API Name of the activity type. Required, string." } ] }, "description": "> **Changes data.** Sending this request approves an asset in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nApproves the current draft of the type, and makes it the live version. This will delete the current live version of the type. Required Permissions: Read-Write Activity Metadata\n\n- **Endpoint:** `POST /rest/v1/activities/external/type/{apiName}/approve.json`\n- **Operation ID:** `approveCustomActivityTypeUsingPOST`\n- **API:** Core API · Activities\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Approve Custom Activity Type on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/activities/approve-custom-activity-type/)\n\n### Parameters\n\n- `apiName` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfCustomActivityType](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofcustomactivitytype/)\n\nDeclared response media type: `application/json`." } }, { "id": "197691e7-c7b5-54b6-b8d7-eeb92a6df3be", "name": "POST · Create Custom Activity Type Attributes", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/activities/external/type/:apiName/attributes/create.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "activities", "external", "type", ":apiName", "attributes", "create.json" ], "variable": [ { "key": "apiName", "value": "", "description": "API Name of the activity type. Required, string." } ] }, "description": "> **Changes data.** Sending this request creates data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nAdds activity attributes to the target type. These are added to the draft version of the type. Required Permissions: Read-Write Activity Metadata\n\n- **Endpoint:** `POST /rest/v1/activities/external/type/{apiName}/attributes/create.json`\n- **Operation ID:** `createCustomActivityTypeAttributesUsingPOST`\n- **API:** Core API · Activities\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Create Custom Activity Type Attributes on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/activities/create-custom-activity-type-attributes/)\n\n### Parameters\n\n- `apiName` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [CustomActivityTypeAttributeRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/customactivitytypeattributerequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `attributes` · array of CustomActivityTypeAttribute · optional — List of attributes to add to the activity type.\n- `attributes[].apiName` · string · required — API Name of the attribute.\n- `attributes[].dataType` · string · optional — Data type of the attribute. Allowed values: `string`, `boolean`, `integer`, `float`, `link`, `email`, `currency`, `date`, `datetime`, `phone`, `text`.\n- `attributes[].description` · string · optional — Description of the attribute.\n- `attributes[].isPrimary` · boolean · optional — Whether the attribute is the primary attribute of the activity type. There may only be one primary attribute at a time.\n- `attributes[].name` · string · required — Human-readable display name of the attribute.\n\n### Responses\n\n- `200` — OK · [ResponseOfCustomActivityType](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofcustomactivitytype/)\n\nDeclared response media type: `application/json`." } }, { "id": "8efef7aa-855c-51d4-bb1c-8c2b9a9a6c7a", "name": "POST · Delete Custom Activity Type Attributes", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/activities/external/type/:apiName/attributes/delete.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "activities", "external", "type", ":apiName", "attributes", "delete.json" ], "variable": [ { "key": "apiName", "value": "", "description": "API Name of the activity type. Required, string." } ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDeletes the target attributes from the custom activity type draft. The apiName of each attribute is the primary key for the update. Required Permissions: Read-Write Activity Metadata\n\n- **Endpoint:** `POST /rest/v1/activities/external/type/{apiName}/attributes/delete.json`\n- **Operation ID:** `deleteCustomActivityTypeAttributesUsingPOST`\n- **API:** Core API · Activities\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete Custom Activity Type Attributes on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/activities/delete-custom-activity-type-attributes/)\n\n### Parameters\n\n- `apiName` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [CustomActivityTypeAttributeRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/customactivitytypeattributerequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `attributes` · array of CustomActivityTypeAttribute · optional — List of attributes to add to the activity type.\n- `attributes[].apiName` · string · required — API Name of the attribute.\n- `attributes[].dataType` · string · optional — Data type of the attribute. Allowed values: `string`, `boolean`, `integer`, `float`, `link`, `email`, `currency`, `date`, `datetime`, `phone`, `text`.\n- `attributes[].description` · string · optional — Description of the attribute.\n- `attributes[].isPrimary` · boolean · optional — Whether the attribute is the primary attribute of the activity type. There may only be one primary attribute at a time.\n- `attributes[].name` · string · required — Human-readable display name of the attribute.\n\n### Responses\n\n- `200` — OK · [ResponseOfCustomActivityType](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofcustomactivitytype/)\n\nDeclared response media type: `application/json`." } }, { "id": "0bedaa0a-7bb1-5b64-a54d-991ead0a0cde", "name": "POST · Update Custom Activity Type Attributes", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/activities/external/type/:apiName/attributes/update.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "activities", "external", "type", ":apiName", "attributes", "update.json" ], "variable": [ { "key": "apiName", "value": "", "description": "API Name of the activity type. Required, string." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdates the attributes of the custom activity type draft. The apiName of each attribute is the primary key for the update. Required Permissions: Read-Write Activity Metadata\n\n- **Endpoint:** `POST /rest/v1/activities/external/type/{apiName}/attributes/update.json`\n- **Operation ID:** `updateCustomActivityTypeAttributesUsingPOST`\n- **API:** Core API · Activities\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Custom Activity Type Attributes on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/activities/update-custom-activity-type-attributes/)\n\n### Parameters\n\n- `apiName` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [CustomActivityTypeAttributeRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/customactivitytypeattributerequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `attributes` · array of CustomActivityTypeAttribute · optional — List of attributes to add to the activity type.\n- `attributes[].apiName` · string · required — API Name of the attribute.\n- `attributes[].dataType` · string · optional — Data type of the attribute. Allowed values: `string`, `boolean`, `integer`, `float`, `link`, `email`, `currency`, `date`, `datetime`, `phone`, `text`.\n- `attributes[].description` · string · optional — Description of the attribute.\n- `attributes[].isPrimary` · boolean · optional — Whether the attribute is the primary attribute of the activity type. There may only be one primary attribute at a time.\n- `attributes[].name` · string · required — Human-readable display name of the attribute.\n\n### Responses\n\n- `200` — OK · [ResponseOfCustomActivityType](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofcustomactivitytype/)\n\nDeclared response media type: `application/json`." } }, { "id": "13ee978a-bd9b-572c-bace-a032d09ec882", "name": "POST · Delete Custom Activity Type", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/activities/external/type/:apiName/delete.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "activities", "external", "type", ":apiName", "delete.json" ], "variable": [ { "key": "apiName", "value": "", "description": "API Name of the activity type. Required, string." } ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDeletes the target custom activity type. The type must first be removed from use by any assets, such as triggers or filters. Required Permissions: Read-Write Activity Metadata\n\n- **Endpoint:** `POST /rest/v1/activities/external/type/{apiName}/delete.json`\n- **Operation ID:** `deleteCustomActivityTypeUsingPOST`\n- **API:** Core API · Activities\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete Custom Activity Type on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/activities/delete-custom-activity-type/)\n\n### Parameters\n\n- `apiName` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfCustomActivityType](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofcustomactivitytype/)\n\nDeclared response media type: `application/json`." } }, { "id": "e38124b6-ae55-538f-98b3-b1f55dbd8f5d", "name": "GET · Describe Custom Activity Type", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/activities/external/type/:apiName/describe.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "activities", "external", "type", ":apiName", "describe.json" ], "query": [ { "key": "draft", "value": "", "description": "draft. Optional, boolean.", "disabled": true } ], "variable": [ { "key": "apiName", "value": "", "description": "API Name of the activity type. Required, string." } ] }, "description": "Returns metadata for a specific custom activity type. Required Permissions: Read-Only Activity Metadata, Read-Write Activity Metadata\n\n- **Endpoint:** `GET /rest/v1/activities/external/type/{apiName}/describe.json`\n- **Operation ID:** `describeCustomActivityTypeUsingGET`\n- **API:** Core API · Activities\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Describe Custom Activity Type on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/activities/describe-custom-activity-type/)\n\n### Parameters\n\n- `apiName` · path variable · string · required\n- `draft` · query param · boolean · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfCustomActivityType](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofcustomactivitytype/)\n\nDeclared response media type: `application/json`." } }, { "id": "6d295812-6579-58b2-a402-b12c8302c890", "name": "POST · Discard Custom Activity Type Draft", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/activities/external/type/:apiName/discardDraft.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "activities", "external", "type", ":apiName", "discardDraft.json" ], "variable": [ { "key": "apiName", "value": "", "description": "API Name of the activity type. Required, string." } ] }, "description": "> **Changes data.** Sending this request discards a draft in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDiscards the current draft of the custom activity type. Required Permissions: Read-Write Activity Metadata\n\n- **Endpoint:** `POST /rest/v1/activities/external/type/{apiName}/discardDraft.json`\n- **Operation ID:** `discardDraftofCustomActivityTypeUsingPOST`\n- **API:** Core API · Activities\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Discard Custom Activity Type Draft on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/activities/discard-custom-activity-type-draft/)\n\n### Parameters\n\n- `apiName` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfCustomActivityType](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofcustomactivitytype/)\n\nDeclared response media type: `application/json`." } }, { "id": "338a39e3-7642-5833-b1de-92462f6d53f5", "name": "GET · Get Custom Activity Types", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/activities/external/types.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "activities", "external", "types.json" ] }, "description": "Returns metadata regarding custom activities provisioned in the target instance. Required Permissions: Read-Only Activity Metadata, Read-Write Activity Metadata\n\n- **Endpoint:** `GET /rest/v1/activities/external/types.json`\n- **Operation ID:** `getCustomActivityTypeUsingGET`\n- **API:** Core API · Activities\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Custom Activity Types on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/activities/get-custom-activity-types/)\n\n### Responses\n\n- `200` — OK · [ResponseOfCustomActivityType](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofcustomactivitytype/)\n\nDeclared response media type: `application/json`." } }, { "id": "6db7afd0-9691-566d-88c9-9270b885c06d", "name": "GET · Get Lead Changes", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/activities/leadchanges.json?nextPageToken=&fields=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "activities", "leadchanges.json" ], "query": [ { "key": "nextPageToken", "value": "", "description": "Token representation of a datetime returned by the Get Paging Token endpoint. This endpoint will return activities after this datetime. Required, string." }, { "key": "fields", "value": "", "description": "Comma-separated list of field names to return changes for. Field names can be retrieved with the Describe Lead API. Required, array of string. Comma-separated list in a single value, e.g. a,b,c." }, { "key": "listId", "value": "", "description": "Id of a static list. If set, will only return activities of members of this static list. Optional, integer (int32).", "disabled": true }, { "key": "leadIds", "value": "", "description": "Comma-separated list of lead ids. If set, will only return activities of the leads with these ids. Allows up to 30 entries. Optional, array of integer (int64). Comma-separated list in a single value, e.g. a,b,c.", "disabled": true }, { "key": "batchSize", "value": "", "description": "Maximum number of records to return. Maximum and default is 300. Optional, integer (int32).", "disabled": true } ] }, "description": "Returns a list of Data Value Changes and New Lead activities after a given datetime. Beginning 2026-09-30, calls to the `Get Lead Activities` and `Get Lead Changes` endpoints which includes the `listId` parameter will fail (error code 1003) if the target lists contain 10,000 or more leads. To avoid service disruptions, ensure that calls are properly scoped to avoid this limit. Required Permissions: Read-Only Activity, Read-Write Activity\n\n- **Endpoint:** `GET /rest/v1/activities/leadchanges.json`\n- **Operation ID:** `getLeadChangesUsingGET`\n- **API:** Core API · Activities\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Lead Changes on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/activities/get-lead-changes/)\n\n### Parameters\n\n- `nextPageToken` · query param · string · required\n- `fields` · query param · array of string · required\n- `listId` · query param · integer (int32) · optional\n- `leadIds` · query param · array of integer (int64) · optional\n- `batchSize` · query param · integer (int32) · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLeadChange](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofleadchange/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n1. Send `GET · Get Paging Token` first, and copy the `nextPageToken` from its response into this request's `nextPageToken` param.\n2. Send this request. If the response has `moreResult` set to `true`, copy the `nextPageToken` from the response into the `nextPageToken` param, and send the request again.\n3. Stop when `moreResult` is `false`.\n4. `batchSize` sets the maximum number of records per response.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "1a845795-5a16-5351-8bf6-8cfa770ee3fb", "name": "GET · Get Paging Token", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/activities/pagingtoken.json?sinceDatetime=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "activities", "pagingtoken.json" ], "query": [ { "key": "sinceDatetime", "value": "", "description": "Earliest datetime to retrieve activities from. Required, string (date-time)." } ] }, "description": "Returns a paging token for use in retrieving activities and data value changes. Required Permissions: Read-Only Activity, Read-Write Activity\n\n- **Endpoint:** `GET /rest/v1/activities/pagingtoken.json`\n- **Operation ID:** `getActivitiesPagingTokenUsingGET`\n- **API:** Core API · Activities\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Paging Token on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/activities/get-paging-token/)\n\n### Parameters\n\n- `sinceDatetime` · query param · string (date-time) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfVoid](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofvoid/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\nUse the `nextPageToken` from this response as the `nextPageToken` param of: `GET · Get Lead Activities`, `GET · Get Deleted Leads`, `GET · Get Lead Changes`.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "a2a3078b-9be4-59a8-93b6-f2ddd23791ab", "name": "GET · Get Activity Types", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/activities/types.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "activities", "types.json" ] }, "description": "Returns a list of available activity types in the target instance, along with associated metadata of each type. Required Permissions: Read-Only Activity, Read-Write Activity\n\n- **Endpoint:** `GET /rest/v1/activities/types.json`\n- **Operation ID:** `getAllActivityTypesUsingGET`\n- **API:** Core API · Activities\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Activity Types on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/activities/get-activity-types/)\n\n### Responses\n\n- `200` — OK · [ResponseOfActivityType](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofactivitytype/)\n\nDeclared response media type: `application/json`." } } ] }, { "id": "bcd4a3f4-d257-5cdc-a909-d3853ce813fd", "name": "Bulk Export Activities", "description": "Bulk Export Activities operations in the Core API. Reference: [Bulk Export Activities](https://mkto-ref.harrisonjennings.au/reference/core/bulk-export-activities/).", "item": [ { "id": "cdd3c93d-c737-5ab6-a637-23211fc3e9c0", "name": "GET · Get Export Activity Jobs", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/bulk/v1/activities/export.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "bulk", "v1", "activities", "export.json" ], "query": [ { "key": "status", "value": "", "description": "Comma separated list of statuses to filter on. Optional, array of string. Comma-separated list in a single value, e.g. a,b,c. Allowed values: `created`, `queued`, `processing`, `cancelled`, `completed`, `failed`.", "disabled": true }, { "key": "batchSize", "value": "", "description": "The batch size to return. The max and default value is 300. Optional, integer (int32).", "disabled": true }, { "key": "nextPageToken", "value": "", "description": "A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info. Optional, string.", "disabled": true } ] }, "description": "Returns a list of export jobs that were created in the past 7 days. Required Permissions: Read-Only Activity\n\n- **Endpoint:** `GET /bulk/v1/activities/export.json`\n- **Operation ID:** `getExportActivitiesUsingGET`\n- **API:** Core API · Bulk Export Activities\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Export Activity Jobs on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/bulk-export-activities/get-export-activity-jobs/)\n\n### Parameters\n\n- `status` · query param · array of string · optional · Allowed values: `created`, `queued`, `processing`, `cancelled`, `completed`, `failed`\n- `batchSize` · query param · integer (int32) · optional\n- `nextPageToken` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfExportResponseWithToken](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofexportresponsewithtoken/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n1. Send this request. To get the next page, copy the `nextPageToken` from the response into the `nextPageToken` param, and send the request again.\n2. `batchSize` sets the maximum number of records per response.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "218f7418-9786-5404-b3f8-428a5a9182dd", "name": "POST · Create Export Activity Job", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"fields\": [],\n \"filter\": {\n \"createdAt\": {}\n }\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/bulk/v1/activities/export/create.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "bulk", "v1", "activities", "export", "create.json" ] }, "description": "> **Changes data.** Sending this request creates data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nCreate export job for search criteria defined via \"filter\" parameter. Request returns the \"exportId\" which is passed as a parameter in subsequent calls to Bulk Export Activities endpoints. Use Enqueue Export Activity Job endpoint to queue the export job for processing. Use Get Export Activity Job Status endpoint to retrieve status of export job. Required Permissions: Read-Only Activity\n\n- **Endpoint:** `POST /bulk/v1/activities/export/create.json`\n- **Operation ID:** `createExportActivitiesUsingPOST`\n- **API:** Core API · Bulk Export Activities\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Create Export Activity Job on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/bulk-export-activities/create-export-activity-job/)\n\n### Request body\n\n`application/json` · optional · model [ExportActivityRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/exportactivityrequest/)\n\nexportActivityRequest\n\nColumnHeaderNames: A JSON object containing key-value pairs of field and column header names.\n\nExample:\n\n```\n\"columnHeaderNames\":{\n \"primaryAttributeValueId\":\"Attribute ID\",\n \"primaryAttributeValue\":\"Attribute Value\",\n \"attributes\":\"Secondary Attributes\"\n}\n```\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `columnHeaderNames` · ColumnHeaderNames · optional — File header field names override (corresponds with REST API name)\n- `columnHeaderNames.name` · string · required — REST API name for header field.\n- `columnHeaderNames.value` · string · required — Value for header field.\n- `fields` · array of string · required — Array of strings containing field values. Used to reduce the number of fields contained in export file. Select one or more of: marketoGUID, leadId, activityDate, activityTypeId, campaignId, primaryAttributeValueId, primaryAttributeValue, actionResult.\n- `filter` · ExportActivityFilter · required — Record selection criteria. \"createdAt\" is required, \"activityTypeIds\", \"primaryAttributeValueIds\", and \"primaryAttributeValues\" are optional.\n- `filter.activityTypeIds` · array of integer (int32) · optional — List of activity type ids to filter on.\n- `filter.primaryAttributeValueIds` · array of integer (int32) · optional — List of primary attribute ids to filter on.\n- `filter.primaryAttributeValues` · array of string · optional — List of primary attribute values to filter on.\n- `filter.createdAt` · DateRange · required — Date range to filter new activities on.\n- `filter.createdAt.endAt` · string · optional — End of date range filter (ISO 8601-format)\n- `filter.createdAt.startAt` · string · optional — Start of date range filter (ISO-8601 format)\n- `format` · string · optional — File format to create(\"CSV\", \"TSV\", \"SSV\"). Default is \"CSV\".\n\n### Responses\n\n- `200` — OK · [ResponseOfExportResponse](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofexportresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "7a02d597-d4f2-5e9b-a0b2-2359b2621cb7", "name": "POST · Cancel Export Activity Job", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/bulk/v1/activities/export/:exportId/cancel.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "bulk", "v1", "activities", "export", ":exportId", "cancel.json" ], "variable": [ { "key": "exportId", "value": "", "description": "Id of export batch job. Required, string." } ] }, "description": "> **Changes data.** Sending this request cancels a job in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nCancel export job. Required Permissions: Read-Only Activity\n\n- **Endpoint:** `POST /bulk/v1/activities/export/{exportId}/cancel.json`\n- **Operation ID:** `cancelExportActivitiesUsingPOST`\n- **API:** Core API · Bulk Export Activities\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Cancel Export Activity Job on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/bulk-export-activities/cancel-export-activity-job/)\n\n### Parameters\n\n- `exportId` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfExportResponse](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofexportresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "ce8f9a96-5a9a-5aa6-98bf-126605f2dfac", "name": "POST · Enqueue Export Activity Job", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/bulk/v1/activities/export/:exportId/enqueue.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "bulk", "v1", "activities", "export", ":exportId", "enqueue.json" ], "variable": [ { "key": "exportId", "value": "", "description": "Id of export batch job. Required, string." } ] }, "description": "> **Changes data.** Sending this request queues a bulk export job for processing in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nEnqueue export job. This will place export job in queue, and will start the job when computing resources become available. The export job must be in \"Created\" state. Use Get Export Activity Job Status endpoint to retrieve status of export job. Required Permissions: Read-Only Activity\n\n- **Endpoint:** `POST /bulk/v1/activities/export/{exportId}/enqueue.json`\n- **Operation ID:** `enqueueExportActivitiesUsingPOST`\n- **API:** Core API · Bulk Export Activities\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Enqueue Export Activity Job on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/bulk-export-activities/enqueue-export-activity-job/)\n\n### Parameters\n\n- `exportId` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfExportResponse](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofexportresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "ddcde445-40da-5528-a356-e5562a32f74d", "name": "GET · Get Export Activity File", "request": { "method": "GET", "header": [ { "key": "Range", "value": "", "type": "text", "description": "To support partial retrieval of extracted data, the HTTP header \"Range\" of type \"bytes\" may be specified. See RFC 2616 \"Range Retrieval Requests\" for more information. If the header is not set, the entire contents will be returned. Optional, string.", "disabled": true } ], "url": { "raw": "{{marketoBaseUrl}}/bulk/v1/activities/export/:exportId/file.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "bulk", "v1", "activities", "export", ":exportId", "file.json" ], "variable": [ { "key": "exportId", "value": "", "description": "Id of export batch job. Required, string." } ] }, "description": "Returns the file content of an export job. The export job must be in \"Completed\" state. Use Get Export Activity Job Status endpoint to retrieve status of export job. Required Permissions: Read-Only Activity\n\nThe file format is specified by calling the Create Export Activity Job endpoint. The following is an example of the default file format (\"CSV\"). Note that the \"attributes\" field is formatted as JSON.\n\n`marketoGUID,leadId,activityDate,activityTypeId,campaignId,primaryAttributeValueId,primaryAttributeValue, attributes`\n`122323,6,2013-09-26T06:56:35+0000,12,11,6,Owyliphys Iledil,[{\"name\":\"Source Type\",\"value\":\"Web page visit\"}]`\n\n- **Endpoint:** `GET /bulk/v1/activities/export/{exportId}/file.json`\n- **Operation ID:** `getExportActivitiesFileUsingGET`\n- **API:** Core API · Bulk Export Activities\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Export Activity File on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/bulk-export-activities/get-export-activity-file/)\n\n### Parameters\n\n- `exportId` · path variable · string · required\n- `Range` · header · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ObservableOfInputStreamRangeContent](https://mkto-ref.harrisonjennings.au/reference/core/models/observableofinputstreamrangecontent/)\n\nDeclared response media type: `application/json`." } }, { "id": "3274a0f6-51d1-50eb-8671-c29d1af4f2b1", "name": "GET · Get Export Activity Job Status", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/bulk/v1/activities/export/:exportId/status.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "bulk", "v1", "activities", "export", ":exportId", "status.json" ], "variable": [ { "key": "exportId", "value": "", "description": "Id of export batch job. Required, string." } ] }, "description": "Returns status of an export job. Job status is available for 30 days after Completed or Failed status was reached. Required Permissions: Read-Only Activity\n\n- **Endpoint:** `GET /bulk/v1/activities/export/{exportId}/status.json`\n- **Operation ID:** `getExportActivitiesStatusUsingGET`\n- **API:** Core API · Bulk Export Activities\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Export Activity Job Status on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/bulk-export-activities/get-export-activity-job-status/)\n\n### Parameters\n\n- `exportId` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfExportResponse](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofexportresponse/)\n\nDeclared response media type: `application/json`." } } ] }, { "id": "653362f1-4106-59ea-8845-5af32ab3b2ef", "name": "Bulk Export Custom Objects", "description": "Bulk Export Custom Objects operations in the Core API. Reference: [Bulk Export Custom Objects](https://mkto-ref.harrisonjennings.au/reference/core/bulk-export-custom-objects/).", "item": [ { "id": "ccdc115c-c514-5961-8928-90a417b98c1c", "name": "GET · Get Export Custom Object Jobs", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/bulk/v1/customobjects/:apiName/export.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "bulk", "v1", "customobjects", ":apiName", "export.json" ], "query": [ { "key": "status", "value": "", "description": "Comma separated list of statuses to filter on. Optional, array of string. Comma-separated list in a single value, e.g. a,b,c. Allowed values: `created`, `queued`, `processing`, `cancelled`, `completed`, `failed`.", "disabled": true }, { "key": "batchSize", "value": "", "description": "The batch size to return. The max and default value is 300. Optional, integer (int32).", "disabled": true }, { "key": "nextPageToken", "value": "", "description": "A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info. Optional, string.", "disabled": true } ], "variable": [ { "key": "apiName", "value": "", "description": "API Name of the custom object for the export batch job. Required, string." } ] }, "description": "Returns a list of export jobs that were created in the past 7 days. Required Permissions: Read-Only Custom Object\n\n- **Endpoint:** `GET /bulk/v1/customobjects/{apiName}/export.json`\n- **Operation ID:** `getExportCustomObjectsUsingGET`\n- **API:** Core API · Bulk Export Custom Objects\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Export Custom Object Jobs on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/bulk-export-custom-objects/get-export-custom-object-jobs/)\n\n### Parameters\n\n- `apiName` · path variable · string · required\n- `status` · query param · array of string · optional · Allowed values: `created`, `queued`, `processing`, `cancelled`, `completed`, `failed`\n- `batchSize` · query param · integer (int32) · optional\n- `nextPageToken` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfExportResponseWithToken](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofexportresponsewithtoken/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n1. Send this request. To get the next page, copy the `nextPageToken` from the response into the `nextPageToken` param, and send the request again.\n2. `batchSize` sets the maximum number of records per response.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "8e3e5663-c321-516c-8202-7e52b8bd498b", "name": "POST · Create Export Custom Object Job", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"fields\": [],\n \"filter\": {}\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/bulk/v1/customobjects/:apiName/export/create.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "bulk", "v1", "customobjects", ":apiName", "export", "create.json" ], "variable": [ { "key": "apiName", "value": "", "description": "API Name of the custom object for the export batch job. Required, string." } ] }, "description": "> **Changes data.** Sending this request creates data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nCreate export job for search criteria defined via \"filter\" parameter. Request returns the \"exportId\" which is passed as a parameter in subsequent calls to Bulk Export Custom Object endpoints. Use Enqueue Export Custom Object Job endpoint to queue the export job for processing. Use Get Export Custom Object Job Status endpoint to retrieve status of export job. Required Permissions: Read-Only Custom Object\n\n- **Endpoint:** `POST /bulk/v1/customobjects/{apiName}/export/create.json`\n- **Operation ID:** `createExportCustomObjectsUsingPOST`\n- **API:** Core API · Bulk Export Custom Objects\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Create Export Custom Object Job on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/bulk-export-custom-objects/create-export-custom-object-job/)\n\n### Parameters\n\n- `apiName` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · optional · model [ExportCustomObjectRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/exportcustomobjectrequest/)\n\nexportCustomObjectRequest\n\nColumnHeaderNames: A JSON object containing key-value pairs of custom object attributes and column header names.\n\nExample:\n\n```\n\"columnHeaderNames\":{\n \"attrName1\":\"value1\",\n \"attrName2\":\"value2\",\n \"attrName3\":\"value3\"\n}\n```\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `columnHeaderNames` · ColumnHeaderNames · optional — File header field names override (corresponds with REST API name)\n- `columnHeaderNames.name` · string · required — REST API name for header field.\n- `columnHeaderNames.value` · string · required — Value for header field.\n- `fields` · array of string · required — Comma-separated list of custom object attributes to include in the file.\n- `filter` · ExportCustomObjectFilter · required — Custom object record selection criteria. Can be one of the following: \"updatedAt\", \"staticListName\", \"staticListId\", \"smartListName\", \"smartListId\".\n- `filter.updatedAt` · DateRange · optional — Date range to filter updated custom objects on.\n- `filter.updatedAt.endAt` · string · optional — End of date range filter (ISO 8601-format)\n- `filter.updatedAt.startAt` · string · optional — Start of date range filter (ISO-8601 format)\n- `filter.smartListId` · integer (int32) · optional — Id of smart list to retrieve leads from.\n- `filter.smartListName` · string · optional — Name of smart list to retrieve leads from.\n- `filter.staticListId` · integer (int32) · optional — Id of static list to retrieve leads from.\n- `filter.staticListName` · string · optional — Name of static list to retrieve leads from.\n- `format` · string · optional — File format to create(\"CSV\", \"TSV\", \"SSV\"). Default is \"CSV\".\n\n### Responses\n\n- `200` — OK · [ResponseOfExportResponse](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofexportresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "975f1ebd-951e-5186-9c3c-904be6176e98", "name": "POST · Cancel Export Custom Object Job", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/bulk/v1/customobjects/:apiName/export/:exportId/cancel.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "bulk", "v1", "customobjects", ":apiName", "export", ":exportId", "cancel.json" ], "variable": [ { "key": "apiName", "value": "", "description": "API Name of the custom object for the export batch job. Required, string." }, { "key": "exportId", "value": "", "description": "Id of export batch job. Required, string." } ] }, "description": "> **Changes data.** Sending this request cancels a job in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nCancel export job. Required Permissions: Read-Only Custom Object\n\n- **Endpoint:** `POST /bulk/v1/customobjects/{apiName}/export/{exportId}/cancel.json`\n- **Operation ID:** `cancelExportCustomObjectsUsingPOST`\n- **API:** Core API · Bulk Export Custom Objects\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Cancel Export Custom Object Job on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/bulk-export-custom-objects/cancel-export-custom-object-job/)\n\n### Parameters\n\n- `apiName` · path variable · string · required\n- `exportId` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfExportResponse](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofexportresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "96096ee5-575b-5a7d-88bb-2a8231e21899", "name": "POST · Enqueue Export Custom Object Job", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/bulk/v1/customobjects/:apiName/export/:exportId/enqueue.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "bulk", "v1", "customobjects", ":apiName", "export", ":exportId", "enqueue.json" ], "variable": [ { "key": "apiName", "value": "", "description": "API Name of the custom object for the export batch job. Required, string." }, { "key": "exportId", "value": "", "description": "Id of export batch job. Required, string." } ] }, "description": "> **Changes data.** Sending this request queues a bulk export job for processing in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nEnqueue export job. This will place export job in queue, and will start the job when computing resources become available. The export job must be in \"Created\" state. Use Get Export Custom Object Job Status endpoint to retrieve status of export job. Required Permissions: Read-Only Custom Object\n\n- **Endpoint:** `POST /bulk/v1/customobjects/{apiName}/export/{exportId}/enqueue.json`\n- **Operation ID:** `enqueueExportCustomObjectsUsingPOST`\n- **API:** Core API · Bulk Export Custom Objects\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Enqueue Export Custom Object Job on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/bulk-export-custom-objects/enqueue-export-custom-object-job/)\n\n### Parameters\n\n- `apiName` · path variable · string · required\n- `exportId` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfExportResponse](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofexportresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "a3c5bc36-c634-59f3-9300-f8f96262595b", "name": "GET · Get Export Custom Object File", "request": { "method": "GET", "header": [ { "key": "Range", "value": "", "type": "text", "description": "To support partial retrieval of extracted data, the HTTP header \"Range\" of type \"bytes\" may be specified. See RFC 2616 \"Range Retrieval Requests\" for more information. If the header is not set, the entire contents will be returned. Optional, string.", "disabled": true } ], "url": { "raw": "{{marketoBaseUrl}}/bulk/v1/customobjects/:apiName/export/:exportId/file.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "bulk", "v1", "customobjects", ":apiName", "export", ":exportId", "file.json" ], "variable": [ { "key": "apiName", "value": "", "description": "API Name of the custom object for the export batch job. Required, string." }, { "key": "exportId", "value": "", "description": "Id of export batch job. Required, string." } ] }, "description": "Returns the file content of an export job. The export job must be in \"Completed\" state. Use Get Export Custom Object Job Status endpoint to retrieve status of export job. Required Permissions: Read-Only Custom Object\n\nThe file format is specified by calling the Create Export Custom Object Job endpoint. The following is an example of the default file format (\"CSV\").\n\n`leadId,marketoGUID,itemName`\n`11,c93f0494-bbd9-44e8-9c0e-dae9b525073f,Hoka One One Mach 4`\n\n- **Endpoint:** `GET /bulk/v1/customobjects/{apiName}/export/{exportId}/file.json`\n- **Operation ID:** `getExportCustomObjectsFileUsingGET`\n- **API:** Core API · Bulk Export Custom Objects\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Export Custom Object File on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/bulk-export-custom-objects/get-export-custom-object-file/)\n\n### Parameters\n\n- `apiName` · path variable · string · required\n- `exportId` · path variable · string · required\n- `Range` · header · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ObservableOfInputStreamRangeContent](https://mkto-ref.harrisonjennings.au/reference/core/models/observableofinputstreamrangecontent/)\n\nDeclared response media type: `application/json`." } }, { "id": "158d9297-8dd7-53b4-bcd4-100cc5eb6051", "name": "GET · Get Export Custom Object Job Status", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/bulk/v1/customobjects/:apiName/export/:exportId/status.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "bulk", "v1", "customobjects", ":apiName", "export", ":exportId", "status.json" ], "variable": [ { "key": "apiName", "value": "", "description": "API Name of the custom object for the export batch job. Required, string." }, { "key": "exportId", "value": "", "description": "Id of export batch job. Required, string." } ] }, "description": "Returns status of an export job. Job status is available for 30 days after Completed or Failed status was reached. Required Permissions: Read-Only Custom Object\n\n- **Endpoint:** `GET /bulk/v1/customobjects/{apiName}/export/{exportId}/status.json`\n- **Operation ID:** `getExportCustomObjectsStatusUsingGET`\n- **API:** Core API · Bulk Export Custom Objects\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Export Custom Object Job Status on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/bulk-export-custom-objects/get-export-custom-object-job-status/)\n\n### Parameters\n\n- `apiName` · path variable · string · required\n- `exportId` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfExportResponse](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofexportresponse/)\n\nDeclared response media type: `application/json`." } } ] }, { "id": "1a2457eb-43f9-514a-9232-39514b0739ef", "name": "Bulk Export Leads", "description": "Bulk Export Leads operations in the Core API. Reference: [Bulk Export Leads](https://mkto-ref.harrisonjennings.au/reference/core/bulk-export-leads/).", "item": [ { "id": "bdb9e153-473e-5809-9181-ef52dbc771f0", "name": "GET · Get Export Lead Jobs", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/bulk/v1/leads/export.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "bulk", "v1", "leads", "export.json" ], "query": [ { "key": "status", "value": "", "description": "Comma separated list of statuses to filter on. Optional, array of string. Comma-separated list in a single value, e.g. a,b,c. Allowed values: `created`, `queued`, `processing`, `cancelled`, `completed`, `failed`.", "disabled": true }, { "key": "batchSize", "value": "", "description": "The batch size to return. The max and default value is 300. Optional, integer (int32).", "disabled": true }, { "key": "nextPageToken", "value": "", "description": "A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info. Optional, string.", "disabled": true } ] }, "description": "Returns a list of export jobs that were created in the past 7 days. Required Permissions: Read-Only Lead\n\n- **Endpoint:** `GET /bulk/v1/leads/export.json`\n- **Operation ID:** `getExportLeadsUsingGET`\n- **API:** Core API · Bulk Export Leads\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Export Lead Jobs on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/bulk-export-leads/get-export-lead-jobs/)\n\n### Parameters\n\n- `status` · query param · array of string · optional · Allowed values: `created`, `queued`, `processing`, `cancelled`, `completed`, `failed`\n- `batchSize` · query param · integer (int32) · optional\n- `nextPageToken` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfExportResponseWithToken](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofexportresponsewithtoken/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n1. Send this request. To get the next page, copy the `nextPageToken` from the response into the `nextPageToken` param, and send the request again.\n2. `batchSize` sets the maximum number of records per response.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "4a7e3988-5e70-5e8f-a139-2149be4f9d8c", "name": "POST · Create Export Lead Job", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"fields\": [],\n \"filter\": {}\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/bulk/v1/leads/export/create.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "bulk", "v1", "leads", "export", "create.json" ] }, "description": "> **Changes data.** Sending this request creates data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nCreate export job for search criteria defined via \"filter\" parameter. Request returns the \"exportId\" which is passed as a parameter in subsequent calls to Bulk Export Leads endpoints. Use Enqueue Export Lead Job endpoint to queue the export job for processing. Use Get Export Lead Job Status endpoint to retrieve status of export job. Required Permissions: Read-Only Lead\n\n- **Endpoint:** `POST /bulk/v1/leads/export/create.json`\n- **Operation ID:** `createExportLeadsUsingPOST`\n- **API:** Core API · Bulk Export Leads\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Create Export Lead Job on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/bulk-export-leads/create-export-lead-job/)\n\n### Request body\n\n`application/json` · optional · model [ExportLeadRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/exportleadrequest/)\n\nexportLeadRequest\n\nColumnHeaderNames: A JSON object containing key-value pairs of field and column header names.\n\nExample:\n\n```\n\"columnHeaderNames\":{\n \"firstName\":\"First Name\",\n \"lastName\":\"Last Name\",\n \"email\":\"Email Address\"\n}\n```\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `columnHeaderNames` · ColumnHeaderNames · optional — File header field names override (corresponds with REST API name)\n- `columnHeaderNames.name` · string · required — REST API name for header field.\n- `columnHeaderNames.value` · string · required — Value for header field.\n- `fields` · array of string · required — Comma-separated list of fields to include in the file.\n- `filter` · ExportLeadFilter · required — Lead record selection criteria. Can be one of the following: \"createdAt\", \"updatedAt\", \"staticListName\", \"staticListId\", \"smartListName\", \"smartListId\".\n- `filter.createdAt` · DateRange · optional — Date range to filter new leads on.\n- `filter.createdAt.endAt` · string · optional — End of date range filter (ISO 8601-format)\n- `filter.createdAt.startAt` · string · optional — Start of date range filter (ISO-8601 format)\n- `filter.smartListId` · integer (int32) · optional — Id of smart list to retrieve leads from.\n- `filter.smartListName` · string · optional — Name of smart list to retrieve leads from.\n- `filter.staticListId` · integer (int32) · optional — Id of static list to retrieve leads from.\n- `filter.staticListName` · string · optional — Name of static list to retrieve leads from.\n- `filter.updatedAt` · DateRange · optional — Date range to filter updated leads on.\n- `filter.updatedAt.endAt` · string · optional — End of date range filter (ISO 8601-format)\n- `filter.updatedAt.startAt` · string · optional — Start of date range filter (ISO-8601 format)\n- `format` · string · optional — File format to create(\"CSV\", \"TSV\", \"SSV\"). Default is \"CSV\".\n\n### Responses\n\n- `200` — OK · [ResponseOfExportResponse](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofexportresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "cdc13372-f053-50ec-968f-f008747b0bd2", "name": "POST · Cancel Export Lead Job", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/bulk/v1/leads/export/:exportId/cancel.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "bulk", "v1", "leads", "export", ":exportId", "cancel.json" ], "variable": [ { "key": "exportId", "value": "", "description": "Id of export batch job. Required, string." } ] }, "description": "> **Changes data.** Sending this request cancels a job in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nCancel export job. Required Permissions: Read-Only Lead\n\n- **Endpoint:** `POST /bulk/v1/leads/export/{exportId}/cancel.json`\n- **Operation ID:** `cancelExportLeadsUsingPOST`\n- **API:** Core API · Bulk Export Leads\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Cancel Export Lead Job on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/bulk-export-leads/cancel-export-lead-job/)\n\n### Parameters\n\n- `exportId` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfExportResponse](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofexportresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "8d90f244-6a36-5930-9cbc-330ed3b49763", "name": "POST · Enqueue Export Lead Job", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/bulk/v1/leads/export/:exportId/enqueue.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "bulk", "v1", "leads", "export", ":exportId", "enqueue.json" ], "variable": [ { "key": "exportId", "value": "", "description": "Id of export batch job. Required, string." } ] }, "description": "> **Changes data.** Sending this request queues a bulk export job for processing in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nEnqueue export job. This will place export job in queue, and will start the job when computing resources become available. The export job must be in \"Created\" state. Use Get Export Lead Job Status endpoint to retrieve status of export job. Required Permissions: Read-Only Lead\n\n- **Endpoint:** `POST /bulk/v1/leads/export/{exportId}/enqueue.json`\n- **Operation ID:** `enqueueExportLeadsUsingPOST`\n- **API:** Core API · Bulk Export Leads\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Enqueue Export Lead Job on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/bulk-export-leads/enqueue-export-lead-job/)\n\n### Parameters\n\n- `exportId` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfExportResponse](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofexportresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "b9611f38-c3c0-55d1-b6f8-68b8fd03a902", "name": "GET · Get Export Lead File", "request": { "method": "GET", "header": [ { "key": "Range", "value": "", "type": "text", "description": "To support partial retrieval of extracted data, the HTTP header \"Range\" of type \"bytes\" may be specified. See RFC 2616 \"Range Retrieval Requests\" for more information. If the header is not set, the entire contents will be returned. Optional, string.", "disabled": true } ], "url": { "raw": "{{marketoBaseUrl}}/bulk/v1/leads/export/:exportId/file.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "bulk", "v1", "leads", "export", ":exportId", "file.json" ], "variable": [ { "key": "exportId", "value": "", "description": "Id of export batch job. Required, string." } ] }, "description": "Returns the file content of an export job. The export job must be in \"Completed\" state. Use Get Export Lead Job Status endpoint to retrieve status of export job. Required Permissions: Read-Only Lead\n\nThe file format is specified by calling the Create Export Lead Job endpoint. The following is an example of the default file format (\"CSV\").\n\n`firstName,lastName,email`\n`Marvin,Gaye,marvin.gaye@motown.com`\n\n- **Endpoint:** `GET /bulk/v1/leads/export/{exportId}/file.json`\n- **Operation ID:** `getExportLeadsFileUsingGET`\n- **API:** Core API · Bulk Export Leads\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Export Lead File on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/bulk-export-leads/get-export-lead-file/)\n\n### Parameters\n\n- `exportId` · path variable · string · required\n- `Range` · header · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ObservableOfInputStreamRangeContent](https://mkto-ref.harrisonjennings.au/reference/core/models/observableofinputstreamrangecontent/)\n\nDeclared response media type: `application/json`." } }, { "id": "9f6069cd-355d-5754-bb71-a6ff7310563e", "name": "GET · Get Export Lead Job Status", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/bulk/v1/leads/export/:exportId/status.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "bulk", "v1", "leads", "export", ":exportId", "status.json" ], "variable": [ { "key": "exportId", "value": "", "description": "Id of export batch job. Required, string." } ] }, "description": "Returns status of an export job. Job status is available for 30 days after Completed or Failed status was reached. Required Permissions: Read-Only Lead\n\n- **Endpoint:** `GET /bulk/v1/leads/export/{exportId}/status.json`\n- **Operation ID:** `getExportLeadsStatusUsingGET`\n- **API:** Core API · Bulk Export Leads\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Export Lead Job Status on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/bulk-export-leads/get-export-lead-job-status/)\n\n### Parameters\n\n- `exportId` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfExportResponse](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofexportresponse/)\n\nDeclared response media type: `application/json`." } } ] }, { "id": "3a5d37fd-18ed-5361-b218-d11580e0d80e", "name": "Bulk Export Program Members", "description": "Bulk Export Program Members operations in the Core API. Reference: [Bulk Export Program Members](https://mkto-ref.harrisonjennings.au/reference/core/bulk-export-program-members/).", "item": [ { "id": "fc1809d9-68c3-57cd-a69a-a683b1f35bbd", "name": "GET · Get Export Program Member Jobs", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/bulk/v1/program/members/export.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "bulk", "v1", "program", "members", "export.json" ], "query": [ { "key": "status", "value": "", "description": "Comma separated list of statuses to filter on. Optional, array of string. Comma-separated list in a single value, e.g. a,b,c. Allowed values: `created`, `queued`, `processing`, `cancelled`, `completed`, `failed`.", "disabled": true }, { "key": "batchSize", "value": "", "description": "The batch size to return. The max and default value is 300. Optional, integer (int32).", "disabled": true }, { "key": "nextPageToken", "value": "", "description": "A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info. Optional, string.", "disabled": true } ] }, "description": "Returns a list of export jobs that were created in the past 7 days. Required Permissions: Read-Only Lead\n\n- **Endpoint:** `GET /bulk/v1/program/members/export.json`\n- **Operation ID:** `getExportProgramMembersUsingGET`\n- **API:** Core API · Bulk Export Program Members\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Export Program Member Jobs on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/bulk-export-program-members/get-export-program-member-jobs/)\n\n### Parameters\n\n- `status` · query param · array of string · optional · Allowed values: `created`, `queued`, `processing`, `cancelled`, `completed`, `failed`\n- `batchSize` · query param · integer (int32) · optional\n- `nextPageToken` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfExportResponseWithToken](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofexportresponsewithtoken/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n1. Send this request. To get the next page, copy the `nextPageToken` from the response into the `nextPageToken` param, and send the request again.\n2. `batchSize` sets the maximum number of records per response.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "9eebc390-73e8-585c-92d6-fc51aad1830c", "name": "POST · Create Export Program Member Job", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"fields\": [],\n \"filter\": {}\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/bulk/v1/program/members/export/create.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "bulk", "v1", "program", "members", "export", "create.json" ] }, "description": "> **Changes data.** Sending this request creates data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nCreate export job for search criteria defined via \"filter\" parameter. Request returns the \"exportId\" which is passed as a parameter in subsequent calls to Bulk Export Program Members endpoints. Use Enqueue Export Program Member Job endpoint to queue the export job for processing. Use Get Export Program Member Job Status endpoint to retrieve status of export job. Required Permissions: Read-Only Lead\n\n- **Endpoint:** `POST /bulk/v1/program/members/export/create.json`\n- **Operation ID:** `createExportProgramMembersUsingPOST`\n- **API:** Core API · Bulk Export Program Members\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Create Export Program Member Job on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/bulk-export-program-members/create-export-program-member-job/)\n\n### Request body\n\n`application/json` · optional · model [ExportProgramMemberRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/exportprogrammemberrequest/)\n\nexportProgramMemberRequest\n\nColumnHeaderNames: A JSON object containing key-value pairs of field and column header names.\n\nExample:\n\n```\n\"columnHeaderNames\":{\n \"firstName\":\"First Name\",\n \"lastName\":\"Last Name\",\n \"email\":\"Email Address\"\n}\n```\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `columnHeaderNames` · ColumnHeaderNames · optional — File header field names override (corresponds with REST API name)\n- `columnHeaderNames.name` · string · required — REST API name for header field.\n- `columnHeaderNames.value` · string · required — Value for header field.\n- `fields` · array of string · required — Comma-separated list of fields to include in the file.\n- `filter` · ExportProgramMemberFilter · required — Program member record selection criteria. Must be the following: \"programId\".\n- `filter.programId` · integer (int32) · optional — Id of program to retrieve members from. Cannot be used in combination with \"programIds\" filter.\n- `filter.programIds` · array of integer (int32) · optional — Array of program ids to retrieve members from. Cannot be used in combination with \"programId\" filter.\n- `filter.isExhausted` · boolean · optional — Filter program membership records for people who have exhausted content.\n- `filter.nurtureCadence` · string · optional — Filter program membership records for a given nurture cadence. Allowed values: `paused`, `normal`.\n- `filter.statusNames` · array of string · optional — Array of program member status names. Can be default and/or user-defined. Multiple status names are ORed together.\n- `filter.updatedAt` · DateRange · optional — Date range to filter program members on.\n- `filter.updatedAt.endAt` · string · optional — End of date range filter (ISO 8601-format)\n- `filter.updatedAt.startAt` · string · optional — Start of date range filter (ISO-8601 format)\n- `format` · string · optional — File format to create(\"CSV\", \"TSV\", \"SSV\"). Default is \"CSV\".\n\n### Responses\n\n- `200` — OK · [ResponseOfExportResponse](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofexportresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "3912401e-2910-5566-8010-565ec7b68732", "name": "POST · Cancel Export Program Member Job", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/bulk/v1/program/members/export/:exportId/cancel.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "bulk", "v1", "program", "members", "export", ":exportId", "cancel.json" ], "variable": [ { "key": "exportId", "value": "", "description": "Id of export batch job. Required, string." } ] }, "description": "> **Changes data.** Sending this request cancels a job in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nCancel export job. Required Permissions: Read-Only Lead\n\n- **Endpoint:** `POST /bulk/v1/program/members/export/{exportId}/cancel.json`\n- **Operation ID:** `cancelExportProgramMembersUsingPOST`\n- **API:** Core API · Bulk Export Program Members\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Cancel Export Program Member Job on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/bulk-export-program-members/cancel-export-program-member-job/)\n\n### Parameters\n\n- `exportId` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfExportResponse](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofexportresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "55db9f8d-b6eb-5008-b8e7-413658dca879", "name": "POST · Enqueue Export Program Member Job", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/bulk/v1/program/members/export/:exportId/enqueue.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "bulk", "v1", "program", "members", "export", ":exportId", "enqueue.json" ], "variable": [ { "key": "exportId", "value": "", "description": "Id of export batch job. Required, string." } ] }, "description": "> **Changes data.** Sending this request queues a bulk export job for processing in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nEnqueue export job. This will place export job in queue, and will start the job when computing resources become available. The export job must be in \"Created\" state. Use Get Export Program Member Job Status endpoint to retrieve status of export job. Required Permissions: Read-Only Lead\n\n- **Endpoint:** `POST /bulk/v1/program/members/export/{exportId}/enqueue.json`\n- **Operation ID:** `enqueueExportProgramMembersUsingPOST`\n- **API:** Core API · Bulk Export Program Members\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Enqueue Export Program Member Job on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/bulk-export-program-members/enqueue-export-program-member-job/)\n\n### Parameters\n\n- `exportId` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfExportResponse](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofexportresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "44fd1b38-4855-5f2b-ae2a-9ce6029c8426", "name": "GET · Get Export Program Member File", "request": { "method": "GET", "header": [ { "key": "Range", "value": "", "type": "text", "description": "To support partial retrieval of extracted data, the HTTP header \"Range\" of type \"bytes\" may be specified. See RFC 2616 \"Range Retrieval Requests\" for more information. If the header is not set, the entire contents will be returned. Optional, string.", "disabled": true } ], "url": { "raw": "{{marketoBaseUrl}}/bulk/v1/program/members/export/:exportId/file.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "bulk", "v1", "program", "members", "export", ":exportId", "file.json" ], "variable": [ { "key": "exportId", "value": "", "description": "Id of export batch job. Required, string." } ] }, "description": "Returns the file content of an export job. The export job must be in \"Completed\" state. Use Get Export Program Member Job Status endpoint to retrieve status of export job. Required Permissions: Read-Only Lead\n\nThe file format is specified by calling the Create Export Program Member Job endpoint. The following is an example of the default file format (\"CSV\").\n\n`firstName,lastName,email`\n`Marvin,Gaye,marvin.gaye@motown.com`\n\n- **Endpoint:** `GET /bulk/v1/program/members/export/{exportId}/file.json`\n- **Operation ID:** `getExportProgramMembersFileUsingGET`\n- **API:** Core API · Bulk Export Program Members\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Export Program Member File on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/bulk-export-program-members/get-export-program-member-file/)\n\n### Parameters\n\n- `exportId` · path variable · string · required\n- `Range` · header · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ObservableOfInputStreamRangeContent](https://mkto-ref.harrisonjennings.au/reference/core/models/observableofinputstreamrangecontent/)\n\nDeclared response media type: `application/json`." } }, { "id": "883ee4e4-0cd9-5b07-a82b-67a94c535308", "name": "GET · Get Export Program Member Job Status", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/bulk/v1/program/members/export/:exportId/status.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "bulk", "v1", "program", "members", "export", ":exportId", "status.json" ], "variable": [ { "key": "exportId", "value": "", "description": "Id of export batch job. Required, string." } ] }, "description": "Returns status of an export job. Job status is available for 30 days after Completed or Failed status was reached. Required Permissions: Read-Only Lead\n\n- **Endpoint:** `GET /bulk/v1/program/members/export/{exportId}/status.json`\n- **Operation ID:** `getExportProgramMembersStatusUsingGET`\n- **API:** Core API · Bulk Export Program Members\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Export Program Member Job Status on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/bulk-export-program-members/get-export-program-member-job-status/)\n\n### Parameters\n\n- `exportId` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfExportResponse](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofexportresponse/)\n\nDeclared response media type: `application/json`." } } ] }, { "id": "6e572947-30b3-5fed-9a5d-1d75c4d45d32", "name": "Bulk Import Custom Objects", "description": "Bulk Import Custom Objects operations in the Core API. Reference: [Bulk Import Custom Objects](https://mkto-ref.harrisonjennings.au/reference/core/bulk-import-custom-objects/).", "item": [ { "id": "4c4ea3b0-a486-56a3-8f98-ef4e76e8f9e2", "name": "POST · Import Custom Objects", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "description": "File containing the data records to import. Required, file. Select a file in the Body tab before sending." } ] }, "url": { "raw": "{{marketoBaseUrl}}/bulk/v1/customobjects/:apiName/import.json?format=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "bulk", "v1", "customobjects", ":apiName", "import.json" ], "query": [ { "key": "format", "value": "", "description": "Import file format. Required, string. Allowed values: `csv`, `tsv`, `ssv`." } ], "variable": [ { "key": "apiName", "value": "", "description": "API Name of the custom object for the import batch job. Required, string." } ] }, "description": "> **Changes data.** Sending this request imports records into the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nImports a file containing data records into the target instance. Required Permissions: Read-Write Custom Object\n\n- **Endpoint:** `POST /bulk/v1/customobjects/{apiName}/import.json`\n- **Operation ID:** `importCustomObjectUsingPOST`\n- **API:** Core API · Bulk Import Custom Objects\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Import Custom Objects on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/bulk-import-custom-objects/import-custom-objects/)\n\n### Parameters\n\n- `apiName` · path variable · string · required\n- `format` · query param · string · required · Allowed values: `csv`, `tsv`, `ssv`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`multipart/form-data` · required\n\nEach form field is a row in the **Body** tab (form-data), with its description. Required fields are enabled; optional fields are disabled until you enable them. File fields have no file selected.\n\n### Responses\n\n- `200` — OK · [ResponseOfImportCustomObjectResponse](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofimportcustomobjectresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "85472c77-3031-588c-abe0-d8c0ee0c2c6a", "name": "GET · Get Import Custom Object Failures", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/bulk/v1/customobjects/:apiName/import/:batchId/failures.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "bulk", "v1", "customobjects", ":apiName", "import", ":batchId", "failures.json" ], "variable": [ { "key": "apiName", "value": "", "description": "API Name of the custom object for the import batch job. Required, string." }, { "key": "batchId", "value": "", "description": "Id of the import batch job. Required, integer (int32)." } ] }, "description": "Returns the list of failures for the import batch job. Required Permissions: Read-Write Custom Object\n\n- **Endpoint:** `GET /bulk/v1/customobjects/{apiName}/import/{batchId}/failures.json`\n- **Operation ID:** `getImportCustomObjectFailuresUsingGET`\n- **API:** Core API · Bulk Import Custom Objects\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Import Custom Object Failures on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/bulk-import-custom-objects/get-import-custom-object-failures/)\n\n### Parameters\n\n- `apiName` · path variable · string · required\n- `batchId` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ObservableOfInputStreamContent](https://mkto-ref.harrisonjennings.au/reference/core/models/observableofinputstreamcontent/)\n\nDeclared response media type: `application/json`." } }, { "id": "a7969689-8604-5324-a46d-3e081cefc241", "name": "GET · Get Import Custom Object Status", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/bulk/v1/customobjects/:apiName/import/:batchId/status.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "bulk", "v1", "customobjects", ":apiName", "import", ":batchId", "status.json" ], "variable": [ { "key": "apiName", "value": "", "description": "API Name of the custom object for the import batch job. Required, string." }, { "key": "batchId", "value": "", "description": "Id of the import batch job. Required, integer (int32)." } ] }, "description": "Returns the status of an import batch job. Required Permissions: Read-Write Custom Object\n\n- **Endpoint:** `GET /bulk/v1/customobjects/{apiName}/import/{batchId}/status.json`\n- **Operation ID:** `getImportCustomObjectStatusUsingGET`\n- **API:** Core API · Bulk Import Custom Objects\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Import Custom Object Status on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/bulk-import-custom-objects/get-import-custom-object-status/)\n\n### Parameters\n\n- `apiName` · path variable · string · required\n- `batchId` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfImportCustomObjectResponse](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofimportcustomobjectresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "4851457c-d965-508e-b425-7f680adb66b0", "name": "GET · Get Import Custom Object Warnings", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/bulk/v1/customobjects/:apiName/import/:batchId/warnings.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "bulk", "v1", "customobjects", ":apiName", "import", ":batchId", "warnings.json" ], "variable": [ { "key": "apiName", "value": "", "description": "API Name of the custom object for the import batch job. Required, string." }, { "key": "batchId", "value": "", "description": "Id of the import batch job. Required, integer (int32)." } ] }, "description": "Returns the list of warnings for the import batch job. Required Permissions: Read-Write Custom Object\n\n- **Endpoint:** `GET /bulk/v1/customobjects/{apiName}/import/{batchId}/warnings.json`\n- **Operation ID:** `getImportCustomObjectWarningsUsingGET`\n- **API:** Core API · Bulk Import Custom Objects\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Import Custom Object Warnings on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/bulk-import-custom-objects/get-import-custom-object-warnings/)\n\n### Parameters\n\n- `apiName` · path variable · string · required\n- `batchId` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ObservableOfInputStreamContent](https://mkto-ref.harrisonjennings.au/reference/core/models/observableofinputstreamcontent/)\n\nDeclared response media type: `application/json`." } } ] }, { "id": "1f1cd131-3c25-52de-9fb1-7f23989c9c53", "name": "Bulk Import Leads", "description": "Bulk Import Leads operations in the Core API. Reference: [Bulk Import Leads](https://mkto-ref.harrisonjennings.au/reference/core/bulk-import-leads/).", "item": [ { "id": "44765b48-8224-5ae8-9b6d-e52bfb2ea365", "name": "POST · Import Leads", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "description": "File containing the data records to import. Required, file. Select a file in the Body tab before sending." } ] }, "url": { "raw": "{{marketoBaseUrl}}/bulk/v1/leads.json?format=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "bulk", "v1", "leads.json" ], "query": [ { "key": "format", "value": "", "description": "Import file format. Required, string. Allowed values: `csv`, `tsv`, `ssv`." }, { "key": "lookupField", "value": "", "description": "Field to use for deduplication. Custom fields (string, email, integer), and the following field types are supported: id, cookies, email, twitterId, facebookId, linkedInId, sfdcAccountId, sfdcContactId, sfdcLeadId, sfdcLeadOwnerId, sfdcOpptyId. Default is email. Note: You can use id for update only operations. Optional, string.", "disabled": true }, { "key": "partitionName", "value": "", "description": "Name of the lead partition to import to. Optional, string.", "disabled": true }, { "key": "listId", "value": "", "description": "Id of the static list to import into. Optional, integer (int32).", "disabled": true } ] }, "description": "> **Changes data.** Sending this request imports records into the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nImports a file containing data records into the target instance. Required Permissions: Read-Write Lead\n\n- **Endpoint:** `POST /bulk/v1/leads.json`\n- **Operation ID:** `importLeadUsingPOST`\n- **API:** Core API · Bulk Import Leads\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Import Leads on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/bulk-import-leads/import-leads/)\n\n### Parameters\n\n- `format` · query param · string · required · Allowed values: `csv`, `tsv`, `ssv`\n- `lookupField` · query param · string · optional\n- `partitionName` · query param · string · optional\n- `listId` · query param · integer (int32) · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`multipart/form-data` · required\n\nEach form field is a row in the **Body** tab (form-data), with its description. Required fields are enabled; optional fields are disabled until you enable them. File fields have no file selected.\n\n### Responses\n\n- `200` — OK · [ResponseOfImportLeadResponse](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofimportleadresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "93cf78e0-1190-5a02-8b02-9a7255f30de4", "name": "GET · Get Import Lead Status", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/bulk/v1/leads/batch/:batchId.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "bulk", "v1", "leads", "batch", ":batchId.json" ], "variable": [ { "key": "batchId", "value": "", "description": "Id of the import batch job. Required, integer (int32)." } ] }, "description": "Returns the status of an import batch job. Required Permissions: Read-Write Lead\n\n- **Endpoint:** `GET /bulk/v1/leads/batch/{batchId}.json`\n- **Operation ID:** `getImportLeadStatusUsingGET`\n- **API:** Core API · Bulk Import Leads\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Import Lead Status on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/bulk-import-leads/get-import-lead-status/)\n\n### Parameters\n\n- `batchId` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfImportLeadResponse](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofimportleadresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "f0253652-6212-58d2-87d1-2f0f46a335e7", "name": "GET · Get Import Lead Failures", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/bulk/v1/leads/batch/:batchId/failures.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "bulk", "v1", "leads", "batch", ":batchId", "failures.json" ], "variable": [ { "key": "batchId", "value": "", "description": "Id of the import batch job. Required, integer (int32)." } ] }, "description": "Returns the list of failures for the import batch job. Required Permissions: Read-Write Lead\n\n- **Endpoint:** `GET /bulk/v1/leads/batch/{batchId}/failures.json`\n- **Operation ID:** `getImportLeadFailuresUsingGET`\n- **API:** Core API · Bulk Import Leads\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Import Lead Failures on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/bulk-import-leads/get-import-lead-failures/)\n\n### Parameters\n\n- `batchId` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ObservableOfInputStreamContent](https://mkto-ref.harrisonjennings.au/reference/core/models/observableofinputstreamcontent/)\n\nDeclared response media type: `application/json`." } }, { "id": "478f24f8-bb1d-5baf-99a8-e39a87275424", "name": "GET · Get Import Lead Warnings", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/bulk/v1/leads/batch/:batchId/warnings.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "bulk", "v1", "leads", "batch", ":batchId", "warnings.json" ], "variable": [ { "key": "batchId", "value": "", "description": "Id of the import batch job. Required, integer (int32)." } ] }, "description": "Returns the list of warnings for the import batch job. Required Permissions: Read-Write Lead\n\n- **Endpoint:** `GET /bulk/v1/leads/batch/{batchId}/warnings.json`\n- **Operation ID:** `getImportLeadWarningsUsingGET`\n- **API:** Core API · Bulk Import Leads\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Import Lead Warnings on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/bulk-import-leads/get-import-lead-warnings/)\n\n### Parameters\n\n- `batchId` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ObservableOfInputStreamContent](https://mkto-ref.harrisonjennings.au/reference/core/models/observableofinputstreamcontent/)\n\nDeclared response media type: `application/json`." } } ] }, { "id": "5f9a164f-a748-57c6-9227-3717f20469fc", "name": "Bulk Import Program Members", "description": "Bulk Import Program Members operations in the Core API. Reference: [Bulk Import Program Members](https://mkto-ref.harrisonjennings.au/reference/core/bulk-import-program-members/).", "item": [ { "id": "065e3de7-3bc6-56fc-afa8-c1e56801acec", "name": "POST · Import Program Members", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "description": "File containing the data records to import. Required, file. Select a file in the Body tab before sending." } ] }, "url": { "raw": "{{marketoBaseUrl}}/bulk/v1/program/:programId/members/import.json?programMemberStatus=&format=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "bulk", "v1", "program", ":programId", "members", "import.json" ], "query": [ { "key": "programMemberStatus", "value": "", "description": "Program member status for members being added. Required, string." }, { "key": "format", "value": "", "description": "Import file format. Required, string. Allowed values: `CSV`, `TSV`, `SSV`." } ], "variable": [ { "key": "programId", "value": "", "description": "Id of the program to add members to. Required, string." } ] }, "description": "> **Changes data.** Sending this request imports records into the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nImports a file containing data records into the target instance. Required Permissions: Read-Write Lead\n\n- **Endpoint:** `POST /bulk/v1/program/{programId}/members/import.json`\n- **Operation ID:** `importProgramMemberUsingPOST`\n- **API:** Core API · Bulk Import Program Members\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Import Program Members on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/bulk-import-program-members/import-program-members/)\n\n### Parameters\n\n- `programId` · path variable · string · required\n- `programMemberStatus` · query param · string · required\n- `format` · query param · string · required · Allowed values: `CSV`, `TSV`, `SSV`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`multipart/form-data` · required\n\nEach form field is a row in the **Body** tab (form-data), with its description. Required fields are enabled; optional fields are disabled until you enable them. File fields have no file selected.\n\n### Responses\n\n- `200` — OK · [ResponseOfImportProgramMemberResponse](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofimportprogrammemberresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "4ef5359a-acf6-5534-bc72-efd58ad6d418", "name": "GET · Get Import Program Member Failures", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/bulk/v1/program/members/import/:batchId/failures.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "bulk", "v1", "program", "members", "import", ":batchId", "failures.json" ], "variable": [ { "key": "batchId", "value": "", "description": "Id of the import batch job. Required, integer (int32)." } ] }, "description": "Returns the list of failures for the import batch job. Required Permissions: Read-Write Lead\n\n- **Endpoint:** `GET /bulk/v1/program/members/import/{batchId}/failures.json`\n- **Operation ID:** `getImportProgramMemberFailuresUsingGET`\n- **API:** Core API · Bulk Import Program Members\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Import Program Member Failures on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/bulk-import-program-members/get-import-program-member-failures/)\n\n### Parameters\n\n- `batchId` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ObservableOfInputStreamContent](https://mkto-ref.harrisonjennings.au/reference/core/models/observableofinputstreamcontent/)\n\nDeclared response media type: `application/json`." } }, { "id": "6c97cedc-a7d7-5726-9081-ae251c6cb4d8", "name": "GET · Get Import Program Member Status", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/bulk/v1/program/members/import/:batchId/status.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "bulk", "v1", "program", "members", "import", ":batchId", "status.json" ], "variable": [ { "key": "batchId", "value": "", "description": "Id of the import batch job. Required, integer (int32)." } ] }, "description": "Returns the status of an import batch job. Required Permissions: Read-Write Lead\n\n- **Endpoint:** `GET /bulk/v1/program/members/import/{batchId}/status.json`\n- **Operation ID:** `getImportProgramMemberStatusUsingGET`\n- **API:** Core API · Bulk Import Program Members\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Import Program Member Status on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/bulk-import-program-members/get-import-program-member-status/)\n\n### Parameters\n\n- `batchId` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfImportProgramMemberResponse](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofimportprogrammemberresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "91454750-a889-50cb-8be8-ebd01e63acd8", "name": "GET · Get Import Program Member Warnings", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/bulk/v1/program/members/import/:batchId/warnings.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "bulk", "v1", "program", "members", "import", ":batchId", "warnings.json" ], "variable": [ { "key": "batchId", "value": "", "description": "Id of the import batch job. Required, integer (int32)." } ] }, "description": "Returns the list of warnings for the import batch job. Required Permissions: Read-Write Lead\n\n- **Endpoint:** `GET /bulk/v1/program/members/import/{batchId}/warnings.json`\n- **Operation ID:** `getImportProgramMemberWarningsUsingGET`\n- **API:** Core API · Bulk Import Program Members\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Import Program Member Warnings on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/bulk-import-program-members/get-import-program-member-warnings/)\n\n### Parameters\n\n- `batchId` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ObservableOfInputStreamContent](https://mkto-ref.harrisonjennings.au/reference/core/models/observableofinputstreamcontent/)\n\nDeclared response media type: `application/json`." } } ] }, { "id": "d547b0a0-1a52-5e92-86a4-14b4596aded1", "name": "Campaigns", "description": "Campaigns operations in the Core API. Reference: [Campaigns](https://mkto-ref.harrisonjennings.au/reference/core/campaigns/).", "item": [ { "id": "b5c59c2a-f24b-5a56-adc4-ed93e177fbbc", "name": "GET · Get Campaigns", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/campaigns.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "campaigns.json" ], "query": [ { "key": "id", "value": "", "description": "Comma-separated list of campaign ids to return records for. Optional, array of integer (int32). Comma-separated list in a single value, e.g. a,b,c.", "disabled": true }, { "key": "name", "value": "", "description": "Comma-separated list of names to filter on. Optional, array of string. Comma-separated list in a single value, e.g. a,b,c.", "disabled": true }, { "key": "programName", "value": "", "description": "Comma-separated list of program names to filter on. If set, will filter to only campaigns which are children of the designated programs. Optional, array of string. Comma-separated list in a single value, e.g. a,b,c.", "disabled": true }, { "key": "workspaceName", "value": "", "description": "Comma-separated list of workspace names to filter on. If set, will only return campaigns in the given workspaces. Optional, array of string. Comma-separated list in a single value, e.g. a,b,c.", "disabled": true }, { "key": "batchSize", "value": "", "description": "Maximum number of records to return. Maximum and default is 300. Optional, integer (int32).", "disabled": true }, { "key": "nextPageToken", "value": "", "description": "A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info. Optional, string.", "disabled": true }, { "key": "isTriggerable", "value": "", "description": "Set to true to return active Campaigns which have a Campaign is Requested trigger and source is Web Service API. Optional, boolean.", "disabled": true } ] }, "description": "> **Deprecated or superseded.** The source description says this operation is deprecated or superseded; see below.\n\nReturns a list of campaign records. Required Permissions: Read-Only Campaigns, Read-Write Campaigns\n\n**Note: This endpoint has been superseded.** Use [Get Smart Campaigns](https://developer.adobe.com/marketo-apis/api/asset/#operation/getAllSmartCampaignsGET) endpoint instead.\n\n- **Endpoint:** `GET /rest/v1/campaigns.json`\n- **Operation ID:** `getCampaignsUsingGET`\n- **API:** Core API · Campaigns\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Campaigns on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/campaigns/get-campaigns/)\n\n### Parameters\n\n- `id` · query param · array of integer (int32) · optional\n- `name` · query param · array of string · optional\n- `programName` · query param · array of string · optional\n- `workspaceName` · query param · array of string · optional\n- `batchSize` · query param · integer (int32) · optional\n- `nextPageToken` · query param · string · optional\n- `isTriggerable` · query param · boolean · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfCampaign](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofcampaign/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n1. Send this request. To get the next page, copy the `nextPageToken` from the response into the `nextPageToken` param, and send the request again.\n2. `batchSize` sets the maximum number of records per response.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "dc096858-0afa-5342-ac6a-9af2d59295e9", "name": "GET · Get Campaign By Id", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/campaigns/:campaignId.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "campaigns", ":campaignId.json" ], "variable": [ { "key": "campaignId", "value": "", "description": "campaignId. Required, integer (int32)." } ] }, "description": "> **Deprecated or superseded.** The source description says this operation is deprecated or superseded; see below.\n\nReturns the record of a campaign by its id. Required Permissions: Read-Only Campaigns, Read-Write Campaigns\n\n**Note: This endpoint has been superseded.** Use [Get Smart Campaign by Id](https://developer.adobe.com/marketo-apis/api/asset/#operation/getSmartCampaignByIdUsingGET) endpoint instead.\n\n- **Endpoint:** `GET /rest/v1/campaigns/{campaignId}.json`\n- **Operation ID:** `getCampaignByIdUsingGET`\n- **API:** Core API · Campaigns\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Campaign By Id on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/campaigns/get-campaign-by-id/)\n\n### Parameters\n\n- `campaignId` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfCampaign](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofcampaign/)\n\nDeclared response media type: `application/json`." } }, { "id": "9ea5572c-b5aa-5e58-a007-419195b1adeb", "name": "POST · Schedule Campaign", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/campaigns/:campaignId/schedule.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "campaigns", ":campaignId", "schedule.json" ], "variable": [ { "key": "campaignId", "value": "", "description": "Id of the batch campaign to schedule. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request schedules a smart campaign to run in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nRemotely schedules a batch campaign to run at a given time. My tokens local to the campaign's parent program can be overridden for the run to customize content. When using the \"cloneToProgramName\" parameter described below, this endpoint is limited to 20 calls per day. Required Permissions: Execute Campaign\n\n- **Endpoint:** `POST /rest/v1/campaigns/{campaignId}/schedule.json`\n- **Operation ID:** `scheduleCampaignUsingPOST`\n- **API:** Core API · Campaigns\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Schedule Campaign on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/campaigns/schedule-campaign/)\n\n### Parameters\n\n- `campaignId` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · optional · model [ScheduleCampaignRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/schedulecampaignrequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `input` · ScheduleCampaignData · optional — Not documented in the source specification.\n- `input.cloneToProgramName` · string · optional — Name of the resulting program. When set, this attribute will cause the campaign, parent program, and all of its assets, to be created with the resulting new name. The parent program will be cloned and the newly created campaign will be scheduled. The resulting program is created underneath the parent. Programs with snippets, push notifications, in-app messages, static lists, reports, and social assets may not be cloned in this way.\n- `input.runAt` · string (date-time) · optional — Datetime to run the campaign at. If unset, the campaign will be run five minutes after the call is made.\n- `input.tokens` · array of Token · optional — List of my tokens to replace during the run of the target campaign. The tokens must be available in a parent program or folder to be replaced during the run.\n- `input.tokens[].name` · string · required — Name of the token. Should be formatted as \"{{my.name}}\".\n- `input.tokens[].value` · string · required — Value of the token.\n\n### Responses\n\n- `200` — OK · [ResponseOfCampaign](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofcampaign/)\n\nDeclared response media type: `application/json`." } }, { "id": "f1fd5c71-a209-5f48-ab2a-034a24155dd6", "name": "POST · Request Campaign", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"leads\": [\n {\n \"id\": null\n }\n ]\n }\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/campaigns/:campaignId/trigger.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "campaigns", ":campaignId", "trigger.json" ], "variable": [ { "key": "campaignId", "value": "", "description": "The id of the campaign to trigger. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request triggers smart campaign processing in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nPasses a set of leads to a trigger campaign to run through the campaign's flow. The designated campaign must have a Campaign is Requested: Web Service API trigger, and must be active. My tokens local to the campaign's parent program can be overridden for the run to customize content. A maximum of 100 leads are allowed per call. Required Permissions: Execute Campaign\n\n- **Endpoint:** `POST /rest/v1/campaigns/{campaignId}/trigger.json`\n- **Operation ID:** `triggerCampaignUsingPOST`\n- **API:** Core API · Campaigns\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Request Campaign on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/campaigns/request-campaign/)\n\n### Parameters\n\n- `campaignId` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · optional · model [TriggerCampaignRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/triggercampaignrequest/)\n\nThe body starts with the required properties only, set to `null`. Replace each `null` with a value, and add any optional properties you need.\n\n**Properties**\n\n- `input` · TriggerCampaignData · required — Object describing trigger configuration for the campaign.\n- `input.leads` · array of InputLead · required — List of leads for input.\n- `input.leads[].id` · integer (int64) · required — Unique integer id of a lead record.\n- `input.tokens` · array of Token · optional — List of my tokens to replace during the run of the target campaign. The tokens must be available in a parent program or folder to be replaced during the run.\n- `input.tokens[].name` · string · required — Name of the token. Should be formatted as \"{{my.name}}\".\n- `input.tokens[].value` · string · required — Value of the token.\n\n### Responses\n\n- `200` — OK · [ResponseOfCampaign](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofcampaign/)\n\nDeclared response media type: `application/json`." } } ] }, { "id": "05cc0930-1e61-54b1-99c6-d16b1e1c42f8", "name": "Companies", "description": "Companies operations in the Core API. Reference: [Companies](https://mkto-ref.harrisonjennings.au/reference/core/companies/).", "item": [ { "id": "da6cb673-6894-51ac-b735-0fc2e5602183", "name": "GET · Get Companies", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/companies.json?filterType=&filterValues=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "companies.json" ], "query": [ { "key": "filterType", "value": "", "description": "The company field to filter on. Searchable fields can be retrieved with the Describe Company call. Required, string." }, { "key": "filterValues", "value": "", "description": "Comma-separated list of values to match against. Required, array of string. Comma-separated list in a single value, e.g. a,b,c." }, { "key": "fields", "value": "", "description": "Comma-separated list of fields to include in the response. Optional, array of string. Comma-separated list in a single value, e.g. a,b,c.", "disabled": true }, { "key": "batchSize", "value": "", "description": "The batch size to return. The max and default value is 300. Optional, integer (int32).", "disabled": true }, { "key": "nextPageToken", "value": "", "description": "A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info. Optional, string.", "disabled": true } ] }, "description": "Retrieves company records from the destination instance based on the submitted filter. Required Permissions: Read-Only Company, Read-Write Company\n\n- **Endpoint:** `GET /rest/v1/companies.json`\n- **Operation ID:** `getCompaniesUsingGET`\n- **API:** Core API · Companies\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Companies on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/companies/get-companies/)\n\n### Parameters\n\n- `filterType` · query param · string · required\n- `filterValues` · query param · array of string · required\n- `fields` · query param · array of string · optional\n- `batchSize` · query param · integer (int32) · optional\n- `nextPageToken` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfCompany](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofcompany/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n1. Send this request. To get the next page, copy the `nextPageToken` from the response into the `nextPageToken` param, and send the request again.\n2. `batchSize` sets the maximum number of records per response.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "4e5af9d3-c03b-53ef-a721-42a6afd7a8ae", "name": "POST · Sync Companies", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"input\": []\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/companies.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "companies.json" ] }, "description": "> **Changes data.** Sending this request creates or updates records in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nAllows inserting, updating, or upserting of company records into Marketo. Required Permissions: Read-Write Company\n\n- **Endpoint:** `POST /rest/v1/companies.json`\n- **Operation ID:** `syncCompaniesUsingPOST`\n- **API:** Core API · Companies\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Sync Companies on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/companies/sync-companies/)\n\n### Request body\n\n`application/json` · required · model [SyncCompanyRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/synccompanyrequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `action` · string · optional — Type of sync operation to perform. Allowed values: `createOnly`, `updateOnly`, `createOrUpdate`.\n- `dedupeBy` · string · optional — Field to deduplicate on. If the value in the field for a given record is not unique, an error will be returned for the individual record.\n- `input` · array of Company · required — List of input records. Each 'Company' object contains a 'searchableField' for lookup purposes, and one or more 'fields' to create or update. Both can be retrieved using the Describe Companies endpoint.\n- `input[].externalCompanyId` · string · optional — Unique id of the company record.\n- `input[].id` · integer · optional — Unique integer id of the company record.\n- `input[].company` · string · optional — Unique name of the company record.\n\n### Responses\n\n- `200` — OK · [ResponseOfCompany](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofcompany/)\n\nDeclared response media type: `application/json`." } }, { "id": "e599a8dc-bd38-5615-86a3-04f0677bb6d2", "name": "POST · Delete Companies", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/companies/delete.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "companies", "delete.json" ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDeletes the included list of company records from the destination instance. Required Permissions: Read-Write Company\n\n- **Endpoint:** `POST /rest/v1/companies/delete.json`\n- **Operation ID:** `deleteCompaniesUsingPOST`\n- **API:** Core API · Companies\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete Companies on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/companies/delete-companies/)\n\n### Request body\n\n`application/json` · required · model [DeleteCompanyRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/deletecompanyrequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `deleteBy` · string · optional — Field to delete company records by. Key may be \"dedupeFields\" or \"idField\".\n- `input` · array of Company · optional — List of company objects. Companies in the list should only contain a member matching the dedupeBy value. Each 'Company' object contains a 'searchableField' for lookup purposes which can be retrieved using the Describe Companies endpoint.\n- `input[].externalCompanyId` · string · optional — Unique id of the company record.\n- `input[].id` · integer · optional — Unique integer id of the company record.\n- `input[].company` · string · optional — Unique name of the company record.\n\n### Responses\n\n- `200` — OK · [ResponseOfCompany](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofcompany/)\n\nDeclared response media type: `application/json`." } }, { "id": "71aa0950-1e59-5ee1-932c-6cb1e2c9ad48", "name": "GET · Describe Companies", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/companies/describe.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "companies", "describe.json" ] }, "description": "Returns metadata about companies and the fields available for interaction via the API. Required Permissions: Read-Only Company, Read-Write Company\n\n- **Endpoint:** `GET /rest/v1/companies/describe.json`\n- **Operation ID:** `describeUsingGET`\n- **API:** Core API · Companies\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Describe Companies on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/companies/describe-companies/)\n\n### Responses\n\n- `200` — OK · [ResponseOfObjectMetaData](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofobjectmetadata/)\n\nDeclared response media type: `application/json`." } }, { "id": "d7193f13-b6e8-5e14-8b4e-4e7a5450067a", "name": "GET · Get Company Field by Name", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/companies/schema/fields/:fieldApiName.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "companies", "schema", "fields", ":fieldApiName.json" ], "variable": [ { "key": "fieldApiName", "value": "", "description": "The API name of company field. Required, string." } ] }, "description": "Retrieves metadata for single company field. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field\n\n- **Endpoint:** `GET /rest/v1/companies/schema/fields/{fieldApiName}.json`\n- **Operation ID:** `getCompanyFieldByNameUsingGET`\n- **API:** Core API · Companies\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Company Field by Name on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/companies/get-company-field-by-name/)\n\n### Parameters\n\n- `fieldApiName` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLeadField](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofleadfield/)\n\nDeclared response media type: `application/json`." } }, { "id": "6cfa7491-a75b-5d20-89b6-160f68e6cf9d", "name": "GET · Get Company Fields", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/companies/schema/fields.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "companies", "schema", "fields.json" ], "query": [ { "key": "batchSize", "value": "", "description": "The batch size to return. The max and default value is 300. Optional, integer (int32).", "disabled": true }, { "key": "nextPageToken", "value": "", "description": "A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info. Optional, string.", "disabled": true } ] }, "description": "Retrieves metadata for all company fields in the target instance. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field\n\n- **Endpoint:** `GET /rest/v1/companies/schema/fields.json`\n- **Operation ID:** `getCompanyFieldsUsingGET`\n- **API:** Core API · Companies\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Company Fields on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/companies/get-company-fields/)\n\n### Parameters\n\n- `batchSize` · query param · integer (int32) · optional\n- `nextPageToken` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLeadField](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofleadfield/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n1. Send this request. If the response has `moreResult` set to `true`, copy the `nextPageToken` from the response into the `nextPageToken` param, and send the request again.\n2. Stop when `moreResult` is `false`.\n3. `batchSize` sets the maximum number of records per response.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } } ] }, { "id": "353d715b-49d9-5c90-9d34-8670142d2589", "name": "Custom Objects", "description": "Custom Objects operations in the Core API. Reference: [Custom Objects](https://mkto-ref.harrisonjennings.au/reference/core/custom-objects/).", "item": [ { "id": "954667a5-b65f-5637-afb4-50893f0a2f62", "name": "GET · List Custom Objects", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/customobjects.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "customobjects.json" ], "query": [ { "key": "names", "value": "", "description": "Comma-separated list of names to filter types on. Optional, array of string. Comma-separated list in a single value, e.g. a,b,c.", "disabled": true } ] }, "description": "Returns a list of Custom Object types available in the target instance, along with id and deduplication information for each type. Required Permissions: Read-Only Custom Object, Read-Write Custom Object\n\n- **Endpoint:** `GET /rest/v1/customobjects.json`\n- **Operation ID:** `listCustomObjectsUsingGET`\n- **API:** Core API · Custom Objects\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [List Custom Objects on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/custom-objects/list-custom-objects/)\n\n### Parameters\n\n- `names` · query param · array of string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfObjectMetaData](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofobjectmetadata/)\n\nDeclared response media type: `application/json`." } }, { "id": "204aa2fa-cc25-5204-9e80-e0c80d11236e", "name": "GET · Get Custom Objects", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/customobjects/:customObjectName.json?filterType=&filterValues=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "customobjects", ":customObjectName.json" ], "query": [ { "key": "filterType", "value": "", "description": "Field to filter on. Searchable fields can be retrieved with Describe Custom Object. Required, string." }, { "key": "filterValues", "value": "", "description": "Comma-separated list of field values to match against. Required, array of string. Comma-separated list in a single value, e.g. a,b,c." }, { "key": "fields", "value": "", "description": "Comma-separated list of fields to return for each record. If unset marketoGuid, dedupeFields, updatedAt, createdAt will be returned. Optional, array of string. Comma-separated list in a single value, e.g. a,b,c.", "disabled": true }, { "key": "batchSize", "value": "", "description": "The batch size to return. The max and default value is 300. Optional, integer (int32).", "disabled": true }, { "key": "nextPageToken", "value": "", "description": "A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info. Optional, string.", "disabled": true } ], "variable": [ { "key": "customObjectName", "value": "", "description": "Name of custom object type to retrieve records for. Required, string." } ] }, "description": "Retrieves a list of custom objects records based on filter and set of values. There are two unique types of requests for this endpoint: one is executed normally using a GET with URL parameters, the other is by passing a JSON object in the body of a POST and specifying _method=GET in the querystring. The latter is used when dedupeFields attribute has more than one field, which is known as a \"compound key\". Required Permissions: Read-Only Custom Object, Read-Write Custom Object\n\n- **Endpoint:** `GET /rest/v1/customobjects/{customObjectName}.json`\n- **Operation ID:** `getCustomObjectsUsingGET`\n- **API:** Core API · Custom Objects\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Custom Objects on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/custom-objects/get-custom-objects/)\n\n### Parameters\n\n- `customObjectName` · path variable · string · required\n- `filterType` · query param · string · required\n- `filterValues` · query param · array of string · required\n- `fields` · query param · array of string · optional\n- `batchSize` · query param · integer (int32) · optional\n- `nextPageToken` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · optional · model [LookupCustomObjectRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/lookupcustomobjectrequest/)\n\nOptional JSON request for retrieving custom objects with compound keys. Example:\n\n```\n{\n\"filterType\":\"dedupeFields\",\n\"fields\":[\n\"marketoGuid\",\n\"Bedrooms\",\n\"yearBuilt\"\n],\n\"input\":[\n{\n\"mlsNum\":\"1962352\",\n\"houseOwnerId\":\"42645756\"\n},\n{\n\"mlsNum\":\"3962352\",\n\"houseOwnerId\":\"62645756\"\n}\n]\n}\n```\n\nThis body is optional and starts empty, so the request is sent without one. If you add a body, Postman sends it with this GET request (body pruning is disabled for it).\n\n**Properties**\n\n- `batchSize` · integer (int32) · optional — Maximum number of records to return in the response. Max and default is 300.\n- `fields` · array of string · optional — List of fields to return. If not specified, will return the following fields: marketoGuid, dedupeFields, updatedAt, createdAt, filterType.\n- `filterType` · string · optional — Field to search on. Valid values are: dedupeFields, idFields, and any field defined in searchableFields attribute of Describe endpoint. Default is dedupeFields.\n- `input` · array of CustomObject · required — Search values when using a compound key. Each element must include each of the fields in the compound key. Compound keys are determined by the contents of \"dedupeFields\" in the Describe result for the object.\n- `input[].marketoGUID` · string · optional — Unique GUID of the custom object records.\n- `input[].reasons` · array of Reason · optional · returned in responses; do not send — List of reasons why an operation did not succeed. Reasons are only present in API responses and should not be submitted.\n- `input[].reasons[].code` · string · required — Integer code of the reason.\n- `input[].reasons[].message` · string · required — Message describing the reason for the status of the operation.\n- `input[].seq` · integer (int32) · optional · returned in responses; do not send — Integer indicating the sequence of the record in response. This value is correlated to the order of the records included in the request input. Seq should only be part of responses and should not be submitted.\n- `nextPageToken` · string · optional — Paging token returned from a previous response.\n\n### Responses\n\n- `200` — OK · [ResponseOfCustomObject](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofcustomobject/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n1. Send this request. If the response has `moreResult` set to `true`, copy the `nextPageToken` from the response into the `nextPageToken` param, and send the request again.\n2. Stop when `moreResult` is `false`.\n3. `batchSize` sets the maximum number of records per response.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "d6f75421-5031-5504-8d19-7913ec0942f8", "name": "POST · Sync Custom Objects", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"input\": []\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/customobjects/:customObjectName.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "customobjects", ":customObjectName.json" ], "variable": [ { "key": "customObjectName", "value": "", "description": "customObjectName. Required, string." } ] }, "description": "> **Changes data.** Sending this request creates or updates records in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nInserts, updates, or upserts custom object records to the target instance. Required Permissions: Read-Write Custom Object\n\n- **Endpoint:** `POST /rest/v1/customobjects/{customObjectName}.json`\n- **Operation ID:** `syncCustomObjectsUsingPOST`\n- **API:** Core API · Custom Objects\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Sync Custom Objects on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/custom-objects/sync-custom-objects/)\n\n### Parameters\n\n- `customObjectName` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [SyncCustomObjectRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/synccustomobjectrequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `action` · string · optional — Type of sync operation to perform. Allowed values: `createOnly`, `updateOnly`, `createOrUpdate`.\n- `dedupeBy` · string · optional — Field to deduplicate on. If the value in the field for a given record is not unique, an error will be returned for the individual record.\n- `input` · array of CustomObject · required — List of input records.\n- `input[].marketoGUID` · string · optional — Unique GUID of the custom object records.\n- `input[].reasons` · array of Reason · optional · returned in responses; do not send — List of reasons why an operation did not succeed. Reasons are only present in API responses and should not be submitted.\n- `input[].reasons[].code` · string · required — Integer code of the reason.\n- `input[].reasons[].message` · string · required — Message describing the reason for the status of the operation.\n- `input[].seq` · integer (int32) · optional · returned in responses; do not send — Integer indicating the sequence of the record in response. This value is correlated to the order of the records included in the request input. Seq should only be part of responses and should not be submitted.\n\n### Responses\n\n- `200` — OK · [ResponseOfCustomObject](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofcustomobject/)\n\nDeclared response media type: `application/json`." } }, { "id": "ee47045d-84ff-5eff-ab29-3e298e057903", "name": "POST · Delete Custom Objects", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"input\": []\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/customobjects/:customObjectName/delete.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "customobjects", ":customObjectName", "delete.json" ], "variable": [ { "key": "customObjectName", "value": "", "description": "customObjectName. Required, string." } ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDeletes a given set of custom object records. Required Permissions: Read-Write Custom Object\n\n- **Endpoint:** `POST /rest/v1/customobjects/{customObjectName}/delete.json`\n- **Operation ID:** `deleteCustomObjectsUsingPOST`\n- **API:** Core API · Custom Objects\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete Custom Objects on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/custom-objects/delete-custom-objects/)\n\n### Parameters\n\n- `customObjectName` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · optional · model [DeleteCustomObjectRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/deletecustomobjectrequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `deleteBy` · string · optional — Field to delete records by. Permissible values are idField or dedupeFields as indicated by the result of the corresponding describe record.\n- `input` · array of CustomObject · required — List of input records.\n- `input[].marketoGUID` · string · optional — Unique GUID of the custom object records.\n- `input[].reasons` · array of Reason · optional · returned in responses; do not send — List of reasons why an operation did not succeed. Reasons are only present in API responses and should not be submitted.\n- `input[].reasons[].code` · string · required — Integer code of the reason.\n- `input[].reasons[].message` · string · required — Message describing the reason for the status of the operation.\n- `input[].seq` · integer (int32) · optional · returned in responses; do not send — Integer indicating the sequence of the record in response. This value is correlated to the order of the records included in the request input. Seq should only be part of responses and should not be submitted.\n\n### Responses\n\n- `200` — OK · [ResponseOfCustomObject](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofcustomobject/)\n\nDeclared response media type: `application/json`." } }, { "id": "6dc6ebf4-61e8-510f-9864-50f4549c8633", "name": "GET · Describe Custom Objects", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/customobjects/:customObjectName/describe.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "customobjects", ":customObjectName", "describe.json" ], "variable": [ { "key": "customObjectName", "value": "", "description": "customObjectName. Required, string." } ] }, "description": "Returns metadata regarding a given custom object. Required Permissions: Read-Only Custom Object, Read-Write Custom Object\n\n- **Endpoint:** `GET /rest/v1/customobjects/{customObjectName}/describe.json`\n- **Operation ID:** `describeUsingGET_1`\n- **API:** Core API · Custom Objects\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Describe Custom Objects on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/custom-objects/describe-custom-objects/)\n\n### Parameters\n\n- `customObjectName` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfObjectMetaData](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofobjectmetadata/)\n\nDeclared response media type: `application/json`." } }, { "id": "09f58884-638e-5968-ad13-d5060ec64263", "name": "GET · List Custom Object Types", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/customobjects/schema.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "customobjects", "schema.json" ], "query": [ { "key": "names", "value": "", "description": "Comma-separated list of API names of custom object types to filter on. Optional, array of string. Comma-separated list in a single value, e.g. a,b,c.", "disabled": true }, { "key": "state", "value": "", "description": "State of custom object type to filter on. By default, if an approved version exists, it is returned. Otherwise, the draft version is returned. Optional, string. Allowed values: `draft`, `approved`, `approvedWithDraft`.", "disabled": true } ] }, "description": "Returns a list of Custom Object Types available in the target instance, along with id, deduplication, relationship, and field information for each type. Required Permissions: Read-Only Custom Object Type, Read-Write Custom Object Type\n\n- **Endpoint:** `GET /rest/v1/customobjects/schema.json`\n- **Operation ID:** `listCustomObjectTypesUsingGET`\n- **API:** Core API · Custom Objects\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [List Custom Object Types on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/custom-objects/list-custom-object-types/)\n\n### Parameters\n\n- `names` · query param · array of string · optional\n- `state` · query param · string · optional · Allowed values: `draft`, `approved`, `approvedWithDraft`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfObjectMetaData](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofobjectmetadata/)\n\nDeclared response media type: `application/json`." } }, { "id": "bb43e2a2-3115-5f5a-b05c-c08b8ebfb57c", "name": "POST · Sync Custom Object Type", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"displayName\": null,\n \"apiName\": null\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/customobjects/schema.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "customobjects", "schema.json" ] }, "description": "> **Changes data.** Sending this request creates or updates records in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nInserts, updates, or upserts custom object type record to the target instance. Required Permissions: Read-Write Custom Object Type\n\n- **Endpoint:** `POST /rest/v1/customobjects/schema.json`\n- **Operation ID:** `syncCustomObjectTypeUsingPOST`\n- **API:** Core API · Custom Objects\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Sync Custom Object Type on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/custom-objects/sync-custom-object-type/)\n\n### Request body\n\n`application/json` · required · model [SyncCustomObjectTypeRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/synccustomobjecttyperequest/)\n\nJSON object containing custom object type attributes\n\nThe body starts with the required properties only, set to `null`. Replace each `null` with a value, and add any optional properties you need.\n\n**Properties**\n\n- `action` · string · optional — Type of sync operation to perform. Default is createOrUpdate. Allowed values: `createOnly`, `updateOnly`, `createOrUpdate`.\n- `displayName` · string · required — UI display-name of the custom object type.\n- `apiName` · string · required — API name of the custom object type.\n- `pluralName` · string · optional — UI plural-name of the custom object type.\n- `description` · string · optional — Description of the custom object type.\n- `showInLeadDetail` · boolean · optional — Whether to show custom object type in lead detail of UI. Default is false.\n\n### Responses\n\n- `200` — OK · [ResponseOfCustomObjectType](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofcustomobjecttype/)\n\nDeclared response media type: `application/json`." } }, { "id": "bba7a7e5-28bb-5c98-8066-d0776a246be0", "name": "POST · Approve Custom Object Type", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/customobjects/schema/:apiName/approve.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "customobjects", "schema", ":apiName", "approve.json" ], "variable": [ { "key": "apiName", "value": "", "description": "API Name of the custom object type to approve. Required, string." } ] }, "description": "> **Changes data.** Sending this request approves an asset in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nApproves the current draft of the type, and makes it the live version. This will delete the current live version of the type. Required Permissions: Read-Write Custom Object Type\n\n- **Endpoint:** `POST /rest/v1/customobjects/schema/{apiName}/approve.json`\n- **Operation ID:** `approveCustomObjectTypeUsingPOST`\n- **API:** Core API · Custom Objects\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Approve Custom Object Type on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/custom-objects/approve-custom-object-type/)\n\n### Parameters\n\n- `apiName` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfCustomObjectType](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofcustomobjecttype/)\n\nDeclared response media type: `application/json`." } }, { "id": "7bcbd70a-0063-5ccf-b9bd-a5da30650cb7", "name": "POST · Discard Custom Object Type Draft", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/customobjects/schema/:apiName/discardDraft.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "customobjects", "schema", ":apiName", "discardDraft.json" ], "variable": [ { "key": "apiName", "value": "", "description": "API Name of the custom object type draft to discard. Required, string." } ] }, "description": "> **Changes data.** Sending this request discards a draft in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDiscards the current draft of the custom object type. Required Permissions: Read-Write Custom Object Type\n\n- **Endpoint:** `POST /rest/v1/customobjects/schema/{apiName}/discardDraft.json`\n- **Operation ID:** `discardCustomObjectTypeUsingPOST`\n- **API:** Core API · Custom Objects\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Discard Custom Object Type Draft on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/custom-objects/discard-custom-object-type-draft/)\n\n### Parameters\n\n- `apiName` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfCustomObjectType](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofcustomobjecttype/)\n\nDeclared response media type: `application/json`." } }, { "id": "21c1f5c9-945d-5a56-95c7-1410d9651362", "name": "POST · Delete Custom Object Type", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/customobjects/schema/:apiName/delete.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "customobjects", "schema", ":apiName", "delete.json" ], "variable": [ { "key": "apiName", "value": "", "description": "API Name of the custom object type to delete. Required, string." } ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDeletes the target custom object type. The type must first be removed from use by any assets, such as triggers or filters. Required Permissions: Read-Write Custom Object Type\n\n- **Endpoint:** `POST /rest/v1/customobjects/schema/{apiName}/delete.json`\n- **Operation ID:** `deleteCustomObjectTypeUsingPOST`\n- **API:** Core API · Custom Objects\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete Custom Object Type on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/custom-objects/delete-custom-object-type/)\n\n### Parameters\n\n- `apiName` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfCustomObjectType](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofcustomobjecttype/)\n\nDeclared response media type: `application/json`." } }, { "id": "265a1a19-3236-55f2-a996-ec4b7702f924", "name": "GET · Describe Custom Object Type", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/customobjects/schema/:apiName/describe.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "customobjects", "schema", ":apiName", "describe.json" ], "query": [ { "key": "state", "value": "", "description": "State of custom object type to filter on. By default, if an approved version exists, it is returned. Otherwise, the draft version is returned. Optional, string. Allowed values: `draft`, `approved`, `approvedWithDraft`.", "disabled": true } ], "variable": [ { "key": "apiName", "value": "", "description": "API name of custom object type to describe. Required, string." } ] }, "description": "Returns metadata regarding a given custom object type (including relationships and fields). Required Permissions: Read-Only Custom Object Type, Read-Write Custom Object Type\n\n- **Endpoint:** `GET /rest/v1/customobjects/schema/{apiName}/describe.json`\n- **Operation ID:** `describeCustomObjectTypeUsingGET`\n- **API:** Core API · Custom Objects\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Describe Custom Object Type on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/custom-objects/describe-custom-object-type/)\n\n### Parameters\n\n- `apiName` · path variable · string · required\n- `state` · query param · string · optional · Allowed values: `draft`, `approved`, `approvedWithDraft`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfObjectMetaData](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofobjectmetadata/)\n\nDeclared response media type: `application/json`." } }, { "id": "404f5e22-faf6-5c1e-aeac-35f75d63245f", "name": "POST · Add Custom Object Type Fields", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"name\": null,\n \"displayName\": null,\n \"dataType\": null\n }\n ]\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/customobjects/schema/:apiName/addField.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "customobjects", "schema", ":apiName", "addField.json" ], "variable": [ { "key": "apiName", "value": "", "description": "API name of custom object type. Required, string." } ] }, "description": "> **Changes data.** Sending this request adds records or associations in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nAdds fields to custom object type. Required Permissions: Read-Write Custom Object Type\n\n- **Endpoint:** `POST /rest/v1/customobjects/schema/{apiName}/addField.json`\n- **Operation ID:** `addCustomObjectTypeFieldsUsingPOST`\n- **API:** Core API · Custom Objects\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Add Custom Object Type Fields on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/custom-objects/add-custom-object-type-fields/)\n\n### Parameters\n\n- `apiName` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [AddCustomObjectTypeFieldsRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/addcustomobjecttypefieldsrequest/)\n\nJSON object containing custom object type fields\n\nThe body starts with the required properties only, set to `null`. Replace each `null` with a value, and add any optional properties you need.\n\n**Properties**\n\n- `input` · array of AddCustomObjectTypeField · required — List of fields to add to custom object type.\n- `input[].name` · string · required — API Name of custom object field.\n- `input[].displayName` · string · required — UI display-name of the custom object field.\n- `input[].dataType` · string · required — Datatype of the custom object field.\n- `input[].description` · string · optional — Description of the custom object field.\n- `input[].isDedupeField` · boolean · optional — Set to true to enable field as unique identifier for deduplicating records. Default is false.\n- `input[].relatedTo` · CustomObjectTypeFieldRelatedTo · optional — Define custom object link field.\n- `input[].relatedTo.name` · string · required — Name of linkable object type.\n- `input[].relatedTo.field` · string · required — Foreign field to which the parent is linked.\n\n### Responses\n\n- `200` — OK · [ResponseOfCustomObjectType](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofcustomobjecttype/)\n\nDeclared response media type: `application/json`." } }, { "id": "e50846db-2c79-512e-93d9-82f133f8705d", "name": "POST · Delete Custom Object Type Fields", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"name\": null\n }\n ]\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/customobjects/schema/:apiName/deleteField.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "customobjects", "schema", ":apiName", "deleteField.json" ], "variable": [ { "key": "apiName", "value": "", "description": "API name of custom object type. Required, string." } ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDeletes fields from custom object type. Required Permissions: Read-Write Custom Object Type\n\n- **Endpoint:** `POST /rest/v1/customobjects/schema/{apiName}/deleteField.json`\n- **Operation ID:** `deleteCustomObjectTypeFieldsUsingPOST`\n- **API:** Core API · Custom Objects\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete Custom Object Type Fields on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/custom-objects/delete-custom-object-type-fields/)\n\n### Parameters\n\n- `apiName` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [DeleteCustomObjectTypeFieldsRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/deletecustomobjecttypefieldsrequest/)\n\nJSON object containing custom object type fields\n\nThe body starts with the required properties only, set to `null`. Replace each `null` with a value, and add any optional properties you need.\n\n**Properties**\n\n- `input` · array of DeleteCustomObjectTypeField · required — List of fields to delete from the custom object type.\n- `input[].name` · string · required — API Name of custom object type field.\n\n### Responses\n\n- `200` — OK · [ResponseOfCustomObjectType](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofcustomobjecttype/)\n\nDeclared response media type: `application/json`." } }, { "id": "d14ad734-4bb3-501a-8468-3b1e335c6084", "name": "POST · Update Custom Object Type Field", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/customobjects/schema/:apiName/:fieldApiName/updateField.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "customobjects", "schema", ":apiName", ":fieldApiName", "updateField.json" ], "variable": [ { "key": "apiName", "value": "", "description": "API name of custom object type. Required, string." }, { "key": "fieldApiName", "value": "", "description": "API name of custom object type field. Required, string." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdates a field in custom object type. Required Permissions: Read-Write Custom Object Type\n\n- **Endpoint:** `POST /rest/v1/customobjects/schema/{apiName}/{fieldApiName}/updateField.json`\n- **Operation ID:** `updateCustomObjectTypeFieldUsingPOST`\n- **API:** Core API · Custom Objects\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Custom Object Type Field on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/custom-objects/update-custom-object-type-field/)\n\n### Parameters\n\n- `apiName` · path variable · string · required\n- `fieldApiName` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [UpdateCustomObjectTypeFieldRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/updatecustomobjecttypefieldrequest/)\n\nJSON object containing custom object type fields\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `name` · string · optional — API Name of custom object field.\n- `displayName` · string · optional — UI display-name of the custom object field.\n- `dataType` · string · optional — Datatype of the custom object field.\n- `description` · string · optional — Description of the custom object field.\n- `isDedupeField` · boolean · optional — Set to true to enable field as unique identifier for deduplicating records. Default is false.\n- `relatedTo` · CustomObjectTypeFieldRelatedTo · optional — Define custom object link field.\n- `relatedTo.name` · string · required — Name of linkable object type.\n- `relatedTo.field` · string · required — Foreign field to which the parent is linked.\n\n### Responses\n\n- `200` — OK · [ResponseOfCustomObjectType](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofcustomobjecttype/)\n\nDeclared response media type: `application/json`." } }, { "id": "111076df-7f6c-5eb8-82be-693cf91a4d89", "name": "GET · Get Custom Object Type Field Data Types", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/customobjects/schema/fieldDataTypes.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "customobjects", "schema", "fieldDataTypes.json" ] }, "description": "Returns a list of permissible data types that are assigned to custom object fields. Required Permissions: Read-Only Custom Object Type, Read-Write Custom Object Type\n\n- **Endpoint:** `GET /rest/v1/customobjects/schema/fieldDataTypes.json`\n- **Operation ID:** `getCustomObjectTypeFieldDataTypesUsingGET`\n- **API:** Core API · Custom Objects\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Custom Object Type Field Data Types on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/custom-objects/get-custom-object-type-field-data-types/)\n\n### Responses\n\n- `200` — OK · [ResponseOfCustomObjectTypeFieldDataTypes](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofcustomobjecttypefielddatatypes/)\n\nDeclared response media type: `application/json`." } }, { "id": "6379da50-99cb-5304-aea6-55390dcfa801", "name": "GET · Get Custom Object Linkable Objects", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/customobjects/schema/linkableObjects.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "customobjects", "schema", "linkableObjects.json" ] }, "description": "Returns a list of linkable custom objects and their fields. Required Permissions: Read-Only Custom Object Type, Read-Write Custom Object Type\n\n- **Endpoint:** `GET /rest/v1/customobjects/schema/linkableObjects.json`\n- **Operation ID:** `getCustomObjectTypeLinkableObjectsUsingGET`\n- **API:** Core API · Custom Objects\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Custom Object Linkable Objects on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/custom-objects/get-custom-object-linkable-objects/)\n\n### Responses\n\n- `200` — OK · [ResponseOfObjectLinkableObject](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofobjectlinkableobject/)\n\nDeclared response media type: `application/json`." } }, { "id": "1df5c838-2263-5028-aef1-1c8faee94dc1", "name": "GET · Get Custom Object Dependent Assets", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/customobjects/schema/:apiName/dependentAssets.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "customobjects", "schema", ":apiName", "dependentAssets.json" ], "variable": [ { "key": "apiName", "value": "", "description": "REST API name for custom object. Required, string." } ] }, "description": "Returns a list of dependent assets for a custom object type, including their in-instance location. Required Permissions: Read-Only Custom Object Type, Read-Write Custom Object Type\n\n- **Endpoint:** `GET /rest/v1/customobjects/schema/{apiName}/dependentAssets.json`\n- **Operation ID:** `getCustomObjectTypeDependentAssetsUsingGET`\n- **API:** Core API · Custom Objects\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Custom Object Dependent Assets on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/custom-objects/get-custom-object-dependent-assets/)\n\n### Parameters\n\n- `apiName` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfObjectDependentAssets](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofobjectdependentassets/)\n\nDeclared response media type: `application/json`." } } ] }, { "id": "d0006d03-5bc3-5273-bafb-a76748d3ce1e", "name": "Leads", "description": "Leads operations in the Core API. Reference: [Leads](https://mkto-ref.harrisonjennings.au/reference/core/leads/).", "item": [ { "id": "23eb55ee-5187-5972-b451-bb0f066b699e", "name": "GET · Get Lead by Id", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/lead/:leadId.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "lead", ":leadId.json" ], "query": [ { "key": "fields", "value": "", "description": "Comma separated list of field names. If omitted, the following default fields will be returned: email, updatedAt, createdAt, lastName, firstName, and id. Optional, array of string. Comma-separated list in a single value, e.g. a,b,c.", "disabled": true } ], "variable": [ { "key": "leadId", "value": "", "description": "The Marketo lead id. Required, integer (int64)." } ] }, "description": "Retrieves a single lead record through its Marketo id. Required Permissions: Read-Only Lead, Read-Write Lead\n\n- **Endpoint:** `GET /rest/v1/lead/{leadId}.json`\n- **Operation ID:** `getLeadByIdUsingGET`\n- **API:** Core API · Leads\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Lead by Id on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/leads/get-lead-by-id/)\n\n### Parameters\n\n- `leadId` · path variable · integer (int64) · required\n- `fields` · query param · array of string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLead](https://mkto-ref.harrisonjennings.au/reference/core/models/responseoflead/)\n\nDeclared response media type: `application/json`." } }, { "id": "86d017fc-ca1e-5797-b888-e0b86af1d422", "name": "GET · Get Leads by Filter Type", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/leads.json?filterType=&filterValues=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "leads.json" ], "query": [ { "key": "filterType", "value": "", "description": "The lead field to filter on. Any custom field (string, email, or integer types only), and any of the following fields are supported: cookies, email, facebookId, id, leadPartitionId, linkedInId, sfdcAccountId, sfdcContactId, sfdcLeadId, sfdcLeadOwnerId, sfdcOpptyId, twitterId. A comprehensive list of fields can be obtained via the Describe Lead2 (http://developers.marketo.com/rest-api/endpoint-reference/lead-database-endpoint-reference/#/Leads/describeUsingGET_6) endpoint. Required, string." }, { "key": "filterValues", "value": "", "description": "A comma-separated list of values to filter on in the specified fields. Required, array of string. Comma-separated list in a single value, e.g. a,b,c." }, { "key": "fields", "value": "", "description": "A comma-separated list of lead fields to return for each record. Optional, array of string. Comma-separated list in a single value, e.g. a,b,c.", "disabled": true }, { "key": "batchSize", "value": "", "description": "The batch size to return. The max and default value is 300. Optional, integer (int32).", "disabled": true }, { "key": "nextPageToken", "value": "", "description": "A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info. Optional, string.", "disabled": true } ] }, "description": "Returns a list of up to 300 leads based on a list of values in a particular field. Required Permissions: Read-Only Lead, Read-Write Lead\n\n- **Endpoint:** `GET /rest/v1/leads.json`\n- **Operation ID:** `getLeadsByFilterUsingGET`\n- **API:** Core API · Leads\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Leads by Filter Type on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/leads/get-leads-by-filter-type/)\n\n### Parameters\n\n- `filterType` · query param · string · required\n- `filterValues` · query param · array of string · required\n- `fields` · query param · array of string · optional\n- `batchSize` · query param · integer (int32) · optional\n- `nextPageToken` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLead](https://mkto-ref.harrisonjennings.au/reference/core/models/responseoflead/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n1. Send this request. If the response has `moreResult` set to `true`, copy the `nextPageToken` from the response into the `nextPageToken` param, and send the request again.\n2. Stop when `moreResult` is `false`.\n3. `batchSize` sets the maximum number of records per response.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "6a30f158-7954-5f26-af5a-8a624786c900", "name": "POST · Sync Leads", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"input\": []\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/leads.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "leads.json" ] }, "description": "> **Changes data.** Sending this request creates or updates records in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nSyncs a list of leads to the target instance. Required Permissions: Read-Write Lead\n\n- **Endpoint:** `POST /rest/v1/leads.json`\n- **Operation ID:** `syncLeadUsingPOST`\n- **API:** Core API · Leads\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Sync Leads on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/leads/sync-leads/)\n\n### Request body\n\n`application/json` · required · model [SyncLeadRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/syncleadrequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `action` · string · optional — Type of sync operation to perform. Defaults to createOrUpdate if unset. Allowed values: `createOnly`, `updateOnly`, `createOrUpdate`, `createDuplicate`.\n- `asyncProcessing` · boolean · optional — If set to true, the call will return immediately.\n- `input` · array of Lead · required — List of leads for input.\n- `input[].id` · integer (int32) · optional — Unique integer id of a lead record.\n- `input[].membership` · ProgramMembership · optional · returned in responses; do not send — Membership data for the parent program. Only returned via Get Leads By Program Id.\n- `input[].membership.acquiredBy` · boolean · optional — Whether the lead was acquired by the parent program.\n- `input[].membership.isExhausted` · boolean · optional — Whether the lead is currently exhausted in the stream, if applicable.\n- `input[].membership.membershipDate` · string · required — Date the lead first became a member of the program.\n- `input[].membership.nurtureCadence` · string · optional — Cadence of the parent stream if applicable.\n- `input[].membership.progressionStatus` · string · required — Program status of the lead in the parent program.\n- `input[].membership.reachedSuccess` · boolean · optional — Whether the lead is in a success-status in the parent program.\n- `input[].membership.stream` · string · optional — Stream that the lead is a member of, if the parent program is an engagement program.\n- `input[].reason` · Reason · optional · returned in responses; do not send — Reason object describing why an operation did not succeed for a record.\n- `input[].reason.code` · string · required — Integer code of the reason.\n- `input[].reason.message` · string · required — Message describing the reason for the status of the operation.\n- `input[].status` · string · optional — Status of the operation performed on the record.\n- `lookupField` · string · optional — Field to deduplicate on. The field must be present in each lead record of the input. Defaults to email if unset.\n- `partitionName` · string · optional — Name of the partition to operate on, if applicable. Should be set whenever possible, when interacting with an instance where partitions are enabled.\n\n### Responses\n\n- `200` — OK · [ResponseOfLead](https://mkto-ref.harrisonjennings.au/reference/core/models/responseoflead/)\n\nDeclared response media type: `application/json`." } }, { "id": "d4281ccd-9d2b-5fa8-9ba1-4db9fcb1eb03", "name": "POST · Delete Leads", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"id\": null\n }\n ]\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/leads/delete.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "leads", "delete.json" ], "query": [ { "key": "id", "value": "", "description": "Parameter can be specified if the request body is empty. Multiple lead ids can be specified. e.g. id=1,2,3,2342. Required unless you send a request body, array of integer (int64). Comma-separated list in a single value, e.g. a,b,c.", "disabled": true } ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDelete a list of leads from the destination instance. Required Permissions: Read-Write Lead\n\n- **Endpoint:** `POST /rest/v1/leads/delete.json`\n- **Operation ID:** `deleteLeadsUsingPOST`\n- **API:** Core API · Leads\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete Leads on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/leads/delete-leads/)\n\n### Parameters\n\n- `id` · query param · array of integer (int64) · required unless you send a request body\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · optional · model [DeleteLeadRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/deleteleadrequest/)\n\nSend either `id` values in the query string or a request body.\n\nThe body starts with the required properties only, set to `null`. Replace each `null` with a value, and add any optional properties you need.\n\n**Properties**\n\n- `input` · array of LeadInputData · required — List of leads for input.\n- `input[].id` · integer (int64) · required — Unique integer id of a lead record.\n\n### Responses\n\n- `200` — OK · [ResponseOfLead](https://mkto-ref.harrisonjennings.au/reference/core/models/responseoflead/)\n\nDeclared response media type: `application/json`." } }, { "id": "7594236e-ec48-57df-9c18-b446e90228f8", "name": "GET · Describe Lead", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/leads/describe.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "leads", "describe.json" ] }, "description": "> **Deprecated or superseded.** The source description says this operation is deprecated or superseded; see below.\n\nReturns metadata about lead objects in the target instance, including a list of all fields available for interaction via the APIs. Required Permissions: Read-Only Lead, Read-Write Lead\n\n**Note: This endpoint has been superseded.** Use [Describe Lead2](https://developer.adobe.com/marketo-apis/api/mapi/#operation/describeUsingGET_6) endpoint instead.\n\n- **Endpoint:** `GET /rest/v1/leads/describe.json`\n- **Operation ID:** `describeUsingGET_2`\n- **API:** Core API · Leads\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Describe Lead on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/leads/describe-lead/)\n\n### Responses\n\n- `200` — OK · [ResponseOfLeadAttribute](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofleadattribute/)\n\nDeclared response media type: `application/json`." } }, { "id": "2624a0e3-7a2f-5204-8c59-22899831f7c3", "name": "GET · Describe Lead2", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/leads/describe2.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "leads", "describe2.json" ] }, "description": "Returns list of searchable fields on lead objects in the target instance. Required Permissions: Read-Only Lead, Read-Write Lead\n\n- **Endpoint:** `GET /rest/v1/leads/describe2.json`\n- **Operation ID:** `describeUsingGET_6`\n- **API:** Core API · Leads\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Describe Lead2 on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/leads/describe-lead2/)\n\n### Responses\n\n- `200` — OK · [ResponseOfLeadAttribute2](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofleadattribute2/)\n\nDeclared response media type: `application/json`." } }, { "id": "85ef586f-8619-5940-8399-196fdca3339b", "name": "GET · Get Lead Field by Name", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/leads/schema/fields/:fieldApiName.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "leads", "schema", "fields", ":fieldApiName.json" ], "variable": [ { "key": "fieldApiName", "value": "", "description": "The API name of lead field. Required, string." } ] }, "description": "Retrieves metadata for single lead field. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field\n\n- **Endpoint:** `GET /rest/v1/leads/schema/fields/{fieldApiName}.json`\n- **Operation ID:** `getLeadFieldByNameUsingGET`\n- **API:** Core API · Leads\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Lead Field by Name on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/leads/get-lead-field-by-name/)\n\n### Parameters\n\n- `fieldApiName` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLeadField](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofleadfield/)\n\nDeclared response media type: `application/json`." } }, { "id": "7ad77912-3930-53cb-a5f4-1994f9f93790", "name": "POST · Update Lead Field", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"input\": []\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/leads/schema/fields/:fieldApiName.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "leads", "schema", "fields", ":fieldApiName.json" ], "variable": [ { "key": "fieldApiName", "value": "", "description": "The API name of lead field. Required, string." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdate metadata for a lead field in the target instance. See update rules [here](https://developers.marketo.com/rest-api/lead-database/leads/#update_field). Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field\n\n- **Endpoint:** `POST /rest/v1/leads/schema/fields/{fieldApiName}.json`\n- **Operation ID:** `updateLeadFieldUsingPOST`\n- **API:** Core API · Leads\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Lead Field on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/leads/update-lead-field/)\n\n### Parameters\n\n- `fieldApiName` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [UpdateLeadFieldRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/updateleadfieldrequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `input` · array of UpdateLeadField · required — Single lead field for input.\n- `input[].displayName` · string · optional — UI display-name of the field.\n- `input[].description` · string · optional — Description of the field.\n- `input[].isHidden` · boolean · optional — If set to true, the field is hidden. Default is false.\n- `input[].isHtmlEncodingInEmail` · boolean · optional — If set to true, field is encoded as HTML in email. Default is true.\n- `input[].isSensitive` · boolean · optional — If set to true, field is marked as sensitive. Default is false.\n\n### Responses\n\n- `200` — OK · [ResponseOfUpdateLeadField](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofupdateleadfield/)\n\nDeclared response media type: `application/json`." } }, { "id": "5cb95ee3-2f3b-5e6c-be80-2465a8f80738", "name": "GET · Get Lead Fields", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/leads/schema/fields.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "leads", "schema", "fields.json" ], "query": [ { "key": "batchSize", "value": "", "description": "The batch size to return. The max and default value is 300. Optional, integer (int32).", "disabled": true }, { "key": "nextPageToken", "value": "", "description": "A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info. Optional, string.", "disabled": true } ] }, "description": "Retrieves metadata for all lead fields in the target instance. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field\n\n- **Endpoint:** `GET /rest/v1/leads/schema/fields.json`\n- **Operation ID:** `getLeadFieldsUsingGET`\n- **API:** Core API · Leads\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Lead Fields on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/leads/get-lead-fields/)\n\n### Parameters\n\n- `batchSize` · query param · integer (int32) · optional\n- `nextPageToken` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLeadField](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofleadfield/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n1. Send this request. If the response has `moreResult` set to `true`, copy the `nextPageToken` from the response into the `nextPageToken` param, and send the request again.\n2. Stop when `moreResult` is `false`.\n3. `batchSize` sets the maximum number of records per response.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "79d6ea23-4901-51bc-9cf6-85b7f9851162", "name": "POST · Create Lead Fields", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"displayName\": null,\n \"name\": null,\n \"dataType\": null\n }\n ]\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/leads/schema/fields.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "leads", "schema", "fields.json" ] }, "description": "> **Changes data.** Sending this request creates data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nCreate lead fields in the target instance. Required Permissions: Read-Write Schema Custom Field\n\n- **Endpoint:** `POST /rest/v1/leads/schema/fields.json`\n- **Operation ID:** `createLeadFieldUsingPOST`\n- **API:** Core API · Leads\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Create Lead Fields on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/leads/create-lead-fields/)\n\n### Request body\n\n`application/json` · required · model [CreateLeadFieldRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/createleadfieldrequest/)\n\nThe body starts with the required properties only, set to `null`. Replace each `null` with a value, and add any optional properties you need.\n\n**Properties**\n\n- `input` · array of CreateLeadField · required — List of lead fields for input.\n- `input[].displayName` · string · required — UI display-name of the field. Must be unique, cannot contain special characters.\n- `input[].name` · string · required — API name of the field. Must be unique, start with a letter, and only contain letters, numbers, or underscore.\n- `input[].description` · string · optional — Description of the field. Default is no description.\n- `input[].dataType` · string · required — Datatype of the field. Allowed values: `boolean`, `currency`, `date`, `datetime`, `email`, `float`, `integer`, `percent`, `phone`, `score`, `string`, `url`.\n- `input[].isHidden` · boolean · optional — If set to true, the field is hidden. Default is false.\n- `input[].isHtmlEncodingInEmail` · boolean · optional — If set to true, field is encoded as HTML in email. Default is true.\n- `input[].isSensitive` · boolean · optional — If set to true, field is marked as sensitive. Default is false.\n\n### Responses\n\n- `200` — OK · [ResponseOfCreateLeadField](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofcreateleadfield/)\n\nDeclared response media type: `application/json`." } }, { "id": "522beb7d-58a7-510d-becb-d342ae0a08b2", "name": "GET · Describe Program Member", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/program/members/describe.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "program", "members", "describe.json" ] }, "description": "> **Deprecated or superseded.** The source description says this operation is deprecated or superseded; see below.\n\nReturns metadata about program member objects in the target instance, including a list of all fields available for interaction via the APIs. Required Permissions: Read-Only Lead, Read-Write Lead\n\n**Note: This endpoint has been superseded.** Use [Describe Program Member](https://developer.adobe.com/marketo-apis/api/mapi/#operation/describeProgramMemberUsingGET2) endpoint instead.\n\n- **Endpoint:** `GET /rest/v1/program/members/describe.json`\n- **Operation ID:** `describeProgramMemberUsingGET`\n- **API:** Core API · Leads\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Describe Program Member on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/leads/describe-program-member/)\n\n### Responses\n\n- `200` — OK · [ResponseOfProgramMemberAttributes](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofprogrammemberattributes/)\n\nDeclared response media type: `application/json`." } }, { "id": "1b118bd1-f2d5-5372-854f-d931c5109af6", "name": "GET · Get Lead Partitions", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/leads/partitions.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "leads", "partitions.json" ] }, "description": "Returns a list of available partitions in the target instance. Required Permissions: Read-Only Lead, Read-Write Lead\n\n- **Endpoint:** `GET /rest/v1/leads/partitions.json`\n- **Operation ID:** `getLeadPartitionsUsingGET`\n- **API:** Core API · Leads\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Lead Partitions on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/leads/get-lead-partitions/)\n\n### Responses\n\n- `200` — OK · [ResponseOfLeadPartition](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofleadpartition/)\n\nDeclared response media type: `application/json`." } }, { "id": "91af59c6-a4bc-5ec0-bbfc-03abefeb7ba7", "name": "POST · Update Lead Partition", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"id\": null,\n \"partitionName\": null\n }\n ]\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/leads/partitions.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "leads", "partitions.json" ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdates the lead partition for a list of leads. Required Permissions: Read-Write Lead\n\n- **Endpoint:** `POST /rest/v1/leads/partitions.json`\n- **Operation ID:** `updatePartitionsUsingPOST`\n- **API:** Core API · Leads\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Lead Partition on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/leads/update-lead-partition/)\n\n### Request body\n\n`application/json` · required · model [UpdateLeadPartitionRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/updateleadpartitionrequest/)\n\nThe body starts with the required properties only, set to `null`. Replace each `null` with a value, and add any optional properties you need.\n\n**Properties**\n\n- `input` · array of UpdateLeadPartition · required — List of leads for input.\n- `input[].id` · integer (int32) · required — Unique integer id of a lead record.\n- `input[].partitionName` · string · required — Name of the partition.\n\n### Responses\n\n- `200` — OK · [ResponseOfLead](https://mkto-ref.harrisonjennings.au/reference/core/models/responseoflead/)\n\nDeclared response media type: `application/json`." } }, { "id": "fe5cd13b-549e-5996-9076-1d79aad722be", "name": "GET · Get Leads by Program Id", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/leads/programs/:programId.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "leads", "programs", ":programId.json" ], "query": [ { "key": "fields", "value": "", "description": "A comma-separated list of fields to be returned for each record. Optional, array of string. Comma-separated list in a single value, e.g. a,b,c.", "disabled": true }, { "key": "batchSize", "value": "", "description": "The batch size to return. The max and default value is 300. Optional, integer (int32).", "disabled": true }, { "key": "nextPageToken", "value": "", "description": "A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info. Optional, string.", "disabled": true } ], "variable": [ { "key": "programId", "value": "", "description": "The id of the program to retrieve from. Required, integer (int32)." } ] }, "description": "Retrieves a list of leads which are members of the designated program. Required Permissions: Read-Only Lead, Read-Write Lead\n\n- **Endpoint:** `GET /rest/v1/leads/programs/{programId}.json`\n- **Operation ID:** `getLeadsByProgramIdUsingGET`\n- **API:** Core API · Leads\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Leads by Program Id on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/leads/get-leads-by-program-id/)\n\n### Parameters\n\n- `programId` · path variable · integer (int32) · required\n- `fields` · query param · array of string · optional\n- `batchSize` · query param · integer (int32) · optional\n- `nextPageToken` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLead](https://mkto-ref.harrisonjennings.au/reference/core/models/responseoflead/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n1. Send this request. If the response has `moreResult` set to `true`, copy the `nextPageToken` from the response into the `nextPageToken` param, and send the request again.\n2. Stop when `moreResult` is `false`.\n3. `batchSize` sets the maximum number of records per response.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "73e5f7fd-39a4-5e18-b38c-3ff045fd239b", "name": "POST · Change Lead Program Status", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"id\": null\n }\n ],\n \"status\": null\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/leads/programs/:programId/status.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "leads", "programs", ":programId", "status.json" ], "variable": [ { "key": "programId", "value": "", "description": "The id of target program. Required, integer (int32)." } ] }, "description": "> **Deprecated or superseded.** The source description says this operation is deprecated or superseded; see below.\n\n> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nChanges the program status of a list of leads in a target program. Only existing members of the program may have their status changed with this API. Required Permissions: Read-Write Lead\n\n**Note: This endpoint has been superseded.** Use [Sync Program Member Status](https://developer.adobe.com/marketo-apis/api/mapi/#operation/syncProgramMemberStatusUsingPOST) endpoint instead.\n\n- **Endpoint:** `POST /rest/v1/leads/programs/{programId}/status.json`\n- **Operation ID:** `changeLeadProgramStatusUsingPOST`\n- **API:** Core API · Leads\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Change Lead Program Status on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/leads/change-lead-program-status/)\n\n### Parameters\n\n- `programId` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [ChangeLeadProgramStatusRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/changeleadprogramstatusrequest/)\n\nThe body starts with the required properties only, set to `null`. Replace each `null` with a value, and add any optional properties you need.\n\n**Properties**\n\n- `input` · array of LeadLookupInputData · required — List of leads for input.\n- `input[].id` · integer (int64) · required — Unique integer id of a lead record.\n- `status` · string · required — Program status of the record. Permissible values can be retrieve from the Get Channel by Name API for the designated program's channel.\n\n### Responses\n\n- `200` — OK · [ResponseOfChangeLeadProgramStatusOutputData](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofchangeleadprogramstatusoutputdata/)\n\nDeclared response media type: `application/json`." } }, { "id": "fedbcba0-4088-5477-a467-5e52f1a0c772", "name": "POST · Push Lead to Marketo", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/leads/push.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "leads", "push.json" ] }, "description": "> **Changes data.** Sending this request creates or updates records in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpserts a lead and generates a Push Lead to Marketo activity. Required Permissions: Read-Write Lead\n\n- **Endpoint:** `POST /rest/v1/leads/push.json`\n- **Operation ID:** `pushToMarketoUsingPOST`\n- **API:** Core API · Leads\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Push Lead to Marketo on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/leads/push-lead-to-marketo/)\n\n### Request body\n\n`application/json` · required · model [PushLeadToMarketoRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/pushleadtomarketorequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `input` · array of PushLead · optional — Not documented in the source specification.\n- `input[].id` · integer (int32) · optional — Unique integer id of a lead record.\n- `input[].reason` · Reason · optional · returned in responses; do not send — Reason object describing why an operation did not succeed for a record.\n- `input[].reason.code` · string · required — Integer code of the reason.\n- `input[].reason.message` · string · required — Message describing the reason for the status of the operation.\n- `input[].status` · string · optional — Status of the operation performed on the record.\n- `lookupField` · string · optional — Not documented in the source specification.\n- `partitionName` · string · optional — Not documented in the source specification.\n- `programName` · string · optional — Not documented in the source specification.\n- `programStatus` · string · optional — Not documented in the source specification.\n- `reason` · string · optional — Not documented in the source specification.\n- `source` · string · optional — Not documented in the source specification.\n\n### Responses\n\n- `200` — OK · [ResponseOfPushLeadToMarketo](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofpushleadtomarketo/)\n\nDeclared response media type: `application/json`." } }, { "id": "29498a29-97d1-51a2-9012-1015bbc135f6", "name": "POST · Submit Form", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"leadFormFields\": {\n \"email\": null\n }\n }\n ],\n \"formId\": null\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/leads/submitForm.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "leads", "submitForm.json" ] }, "description": "> **Changes data.** Sending this request submits data to the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpserts a lead and generates a \"Fill out Form\" activity which is associated back to program and/or campaign. Required Permissions: Read-Write Lead\n\n- **Endpoint:** `POST /rest/v1/leads/submitForm.json`\n- **Operation ID:** `SubmitFormUsingPOST`\n- **API:** Core API · Leads\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Submit Form on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/leads/submit-form/)\n\n### Request body\n\n`application/json` · required · model [SubmitFormRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/submitformrequest/)\n\nThe body starts with the required properties only, set to `null`. Replace each `null` with a value, and add any optional properties you need.\n\n**Properties**\n\n- `input` · array of Form · required — Single array item that contains form fields and visitor data to use during a form submittal.\n- `input[].leadFormFields` · LeadFormFields · required — List of form fields. Email is required field.\n- `input[].leadFormFields.email` · string · required — Email address used as primary key during lead upsert.\n- `input[].visitorData` · VisitorData · optional — Page visit-related data.\n- `input[].visitorData.pageURL` · string · optional — Web page that hosts the form. Must be a fully formed URL.\n- `input[].visitorData.queryString` · string · optional — Web page query string. Contains one or more ampersand delimited key=value pairs.\n- `input[].visitorData.leadClientIpAddress` · string · optional — Client IP address. IPv4 format. Used to populate inferred fields on upserted lead record.\n- `input[].visitorData.userAgentString` · string · optional — User agent of browser hosting the form.\n- `input[].cookie` · string · optional — Munchkin cookie value used to associate new lead with anonymous activities. e.g. id:123-XYZ-456&tooken:_mch-marketo.com-1594662481190-60776.\n- `formId` · integer (int32) · required — Id of the form.\n- `programId` · integer (int32) · optional — Id of the program to add lead and/or program member custom fields to.\n\n### Responses\n\n- `200` — OK · [ResponseOfSubmitForm](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofsubmitform/)\n\nDeclared response media type: `application/json`." } }, { "id": "0d730f2e-0e8e-5ae3-8287-a7f808d57ccb", "name": "POST · Associate Lead", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/leads/:leadId/associate.json?cookie=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "leads", ":leadId", "associate.json" ], "query": [ { "key": "cookie", "value": "", "description": "The cookie value to associate. Required, string." } ], "variable": [ { "key": "leadId", "value": "", "description": "The id of the lead to associate. Required, integer (int64)." } ] }, "description": "> **Changes data.** Sending this request associates records in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nAssociates a known Marketo lead record to a munchkin cookie and its associated web activity history. Required Permissions: Read-Write Lead\n\n- **Endpoint:** `POST /rest/v1/leads/{leadId}/associate.json`\n- **Operation ID:** `associateLeadUsingPOST`\n- **API:** Core API · Leads\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Associate Lead on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/leads/associate-lead/)\n\n### Parameters\n\n- `leadId` · path variable · integer (int64) · required\n- `cookie` · query param · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseWithoutResult](https://mkto-ref.harrisonjennings.au/reference/core/models/responsewithoutresult/)\n\nDeclared response media type: `application/json`." } }, { "id": "3347b19b-4f27-504d-a046-4350bde4c1f4", "name": "POST · Merge Leads", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/leads/:leadId/merge.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "leads", ":leadId", "merge.json" ], "query": [ { "key": "leadId", "value": "", "description": "The id of the losing record. Optional, integer (int64).", "disabled": true }, { "key": "leadIds", "value": "", "description": "A comma-separated list of ids of losing records. Optional, array of integer (int64). Comma-separated list in a single value, e.g. a,b,c.", "disabled": true }, { "key": "mergeInCRM", "value": "", "description": "If set, will attempt to merge the designated records in a natively-synched CRM. Only valid for instances with are natively synched to SFDC. Optional, boolean.", "disabled": true } ], "variable": [ { "key": "leadId", "value": "", "description": "The id of the winning lead record. Required, integer (int64)." } ] }, "description": "> **Changes data.** Sending this request merges records in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nMerges two or more known lead records into a single lead record. Required Permissions: Read-Write Lead\n\n- **Endpoint:** `POST /rest/v1/leads/{leadId}/merge.json`\n- **Operation ID:** `mergeLeadsUsingPOST`\n- **API:** Core API · Leads\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Merge Leads on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/leads/merge-leads/)\n\n### Parameters\n\n- `leadId` · path variable · integer (int64) · required\n- `leadId` · query param · integer (int64) · optional\n- `leadIds` · query param · array of integer (int64) · optional\n- `mergeInCRM` · query param · boolean · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseWithoutResult](https://mkto-ref.harrisonjennings.au/reference/core/models/responsewithoutresult/)\n\nDeclared response media type: `application/json`." } }, { "id": "5d0131d4-0f93-58b6-9922-4775c05aec4b", "name": "GET · Get Lists by Lead Id", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/leads/:leadId/listMembership.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "leads", ":leadId", "listMembership.json" ], "query": [ { "key": "nextPageToken", "value": "", "description": "A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info. Optional, string.", "disabled": true }, { "key": "batchSize", "value": "", "description": "Maximum number of records to return. Maximum and default is 300. Optional, integer (int32).", "disabled": true } ], "variable": [ { "key": "leadId", "value": "", "description": "The Marketo lead id. Required, integer (int64)." } ] }, "description": "Query static list membership for one lead. Required Permissions: Read-Only Asset\n\n- **Endpoint:** `GET /rest/v1/leads/{leadId}/listMembership.json`\n- **Operation ID:** `getListMembershipUsingGET`\n- **API:** Core API · Leads\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Lists by Lead Id on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/leads/get-lists-by-lead-id/)\n\n### Parameters\n\n- `leadId` · path variable · integer (int64) · required\n- `nextPageToken` · query param · string · optional\n- `batchSize` · query param · integer (int32) · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLists](https://mkto-ref.harrisonjennings.au/reference/core/models/responseoflists/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n1. Send this request. If the response has `moreResult` set to `true`, copy the `nextPageToken` from the response into the `nextPageToken` param, and send the request again.\n2. Stop when `moreResult` is `false`.\n3. `batchSize` sets the maximum number of records per response.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "df5002f4-8a08-5b68-9db7-e1596789a0d5", "name": "GET · Get Programs by Lead Id", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/leads/:leadId/programMembership.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "leads", ":leadId", "programMembership.json" ], "query": [ { "key": "nextPageToken", "value": "", "description": "A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info. Optional, string.", "disabled": true }, { "key": "batchSize", "value": "", "description": "Maximum number of records to return. Maximum and default is 300. Optional, integer (int32).", "disabled": true }, { "key": "earliestUpdatedAt", "value": "", "description": "Exclude programs prior to this date. Must be valid ISO-8601 string. See Datetime (http://developers.marketo.com/rest-api/lead-database/fields/field-types/) field type description. Optional, string.", "disabled": true }, { "key": "latestUpdatedAt", "value": "", "description": "Exclude programs after this date. Must be valid ISO-8601 string. See Datetime (http://developers.marketo.com/rest-api/lead-database/fields/field-types/) field type description. Optional, string.", "disabled": true }, { "key": "filterType", "value": "", "description": "Set to \"programId\" to filter a set of programs. Optional, string.", "disabled": true }, { "key": "filterValues", "value": "", "description": "Comma-separated list of program ids to match against. Optional, array of string. Comma-separated list in a single value, e.g. a,b,c.", "disabled": true } ], "variable": [ { "key": "leadId", "value": "", "description": "The Marketo lead id. Required, integer (int64)." } ] }, "description": "Query program membership for one lead. Required Permissions: Read-Only Asset\n\n- **Endpoint:** `GET /rest/v1/leads/{leadId}/programMembership.json`\n- **Operation ID:** `getProgramMembershipUsingGET`\n- **API:** Core API · Leads\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Programs by Lead Id on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/leads/get-programs-by-lead-id/)\n\n### Parameters\n\n- `leadId` · path variable · integer (int64) · required\n- `nextPageToken` · query param · string · optional\n- `batchSize` · query param · integer (int32) · optional\n- `earliestUpdatedAt` · query param · string · optional\n- `latestUpdatedAt` · query param · string · optional\n- `filterType` · query param · string · optional\n- `filterValues` · query param · array of string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfPrograms](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofprograms/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n1. Send this request. If the response has `moreResult` set to `true`, copy the `nextPageToken` from the response into the `nextPageToken` param, and send the request again.\n2. Stop when `moreResult` is `false`.\n3. `batchSize` sets the maximum number of records per response.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "4df3bbe2-3a5d-5c4f-b3af-f0d8ee0dfacd", "name": "GET · Get Smart Campaigns by Lead Id", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/leads/:leadId/smartCampaignMembership.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "leads", ":leadId", "smartCampaignMembership.json" ], "query": [ { "key": "nextPageToken", "value": "", "description": "A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info. Optional, string.", "disabled": true }, { "key": "batchSize", "value": "", "description": "Maximum number of records to return. Maximum and default is 300. Optional, integer (int32).", "disabled": true }, { "key": "earliestUpdatedAt", "value": "", "description": "Exclude smart campaigns prior to this date. Must be valid ISO-8601 string. See Datetime (http://developers.marketo.com/rest-api/lead-database/fields/field-types/) field type description. Optional, string.", "disabled": true }, { "key": "latestUpdatedAt", "value": "", "description": "Exclude smart campaigns after this date. Must be valid ISO-8601 string. See Datetime (http://developers.marketo.com/rest-api/lead-database/fields/field-types/) field type description. Optional, string.", "disabled": true } ], "variable": [ { "key": "leadId", "value": "", "description": "The Marketo lead id. Required, integer (int64)." } ] }, "description": "Query smart campaign membership for one lead. Required Permissions: Read-Only Asset\n\n- **Endpoint:** `GET /rest/v1/leads/{leadId}/smartCampaignMembership.json`\n- **Operation ID:** `getSmartCampaignMembershipUsingGET`\n- **API:** Core API · Leads\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Smart Campaigns by Lead Id on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/leads/get-smart-campaigns-by-lead-id/)\n\n### Parameters\n\n- `leadId` · path variable · integer (int64) · required\n- `nextPageToken` · query param · string · optional\n- `batchSize` · query param · integer (int32) · optional\n- `earliestUpdatedAt` · query param · string · optional\n- `latestUpdatedAt` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfSmartCampaigns](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofsmartcampaigns/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n1. Send this request. If the response has `moreResult` set to `true`, copy the `nextPageToken` from the response into the `nextPageToken` param, and send the request again.\n2. Stop when `moreResult` is `false`.\n3. `batchSize` sets the maximum number of records per response.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } } ] }, { "id": "85ba3da0-96bf-561d-b992-f23c1e1b6ecb", "name": "Named Account Lists", "description": "Named Account Lists operations in the Core API. Reference: [Named Account Lists](https://mkto-ref.harrisonjennings.au/reference/core/named-account-lists/).", "item": [ { "id": "27d5c775-38ac-546a-bdd3-89aee7b23948", "name": "GET · Get Named Account List Members", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/namedAccountList/:id/namedAccounts.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "namedAccountList", ":id", "namedAccounts.json" ], "query": [ { "key": "fields", "value": "", "description": "Comma-separated list of fields to include in the response. Optional, array of string. Comma-separated list in a single value, e.g. a,b,c.", "disabled": true }, { "key": "batchSize", "value": "", "description": "The batch size to return. The max and default value is 300. Optional, integer (int32).", "disabled": true }, { "key": "nextPageToken", "value": "", "description": "A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info. Optional, string.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "Id of the named account list. Required, string." } ] }, "description": "Retrieves the named accounts which are members of the given list. Required Permissions: Read-Only Named Account, Read-Write Named Account\n\n- **Endpoint:** `GET /rest/v1/namedAccountList/{id}/namedAccounts.json`\n- **Operation ID:** `getNamedAccountListMembersUsingGET`\n- **API:** Core API · Named Account Lists\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Named Account List Members on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/named-account-lists/get-named-account-list-members/)\n\n### Parameters\n\n- `id` · path variable · string · required\n- `fields` · query param · array of string · optional\n- `batchSize` · query param · integer (int32) · optional\n- `nextPageToken` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfNamedAccount](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofnamedaccount/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n1. Send this request. If the response has `moreResult` set to `true`, copy the `nextPageToken` from the response into the `nextPageToken` param, and send the request again.\n2. Stop when `moreResult` is `false`.\n3. `batchSize` sets the maximum number of records per response.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "ddc16631-0e10-5558-9520-eeb009d19450", "name": "POST · Add Named Account List Members", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"input\": []\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/namedAccountList/:id/namedAccounts.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "namedAccountList", ":id", "namedAccounts.json" ], "variable": [ { "key": "id", "value": "", "description": "Id of target named account list. Required, string." } ] }, "description": "> **Changes data.** Sending this request adds records or associations in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nAdds named account records to a named account list. Required Permissions: Read-Write Named Account\n\n- **Endpoint:** `POST /rest/v1/namedAccountList/{id}/namedAccounts.json`\n- **Operation ID:** `addNamedAccountListMembersUsingPOST`\n- **API:** Core API · Named Account Lists\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Add Named Account List Members on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/named-account-lists/add-named-account-list-members/)\n\n### Parameters\n\n- `id` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [AddNamedAccountListMemberRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/addnamedaccountlistmemberrequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `input` · array of NamedAccount · required — List of input records.\n- `input[].marketoGUID` · string · optional — Unique GUID of the custom object records.\n- `input[].reasons` · array of Reason · optional · returned in responses; do not send — List of reasons why an operation did not succeed. Reasons are only present in API responses and should not be submitted.\n- `input[].reasons[].code` · string · required — Integer code of the reason.\n- `input[].reasons[].message` · string · required — Message describing the reason for the status of the operation.\n- `input[].seq` · integer (int32) · optional · returned in responses; do not send — Integer indicating the sequence of the record in response. This value is correlated to the order of the records included in the request input. Seq should only be part of responses and should not be submitted.\n- `input[].status` · string · optional — Not documented in the source specification. Allowed values: `created`, `updated`, `deleted`, `skipped`, `added`, `removed`.\n\n### Responses\n\n- `200` — OK · [ResponseOfNamedAccount](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofnamedaccount/)\n\nDeclared response media type: `application/json`." } }, { "id": "6820b541-cc5c-54f8-918c-17fdb5744121", "name": "POST · Remove Named Account List Members", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"input\": []\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/namedAccountList/:id/namedAccounts/remove.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "namedAccountList", ":id", "namedAccounts", "remove.json" ], "variable": [ { "key": "id", "value": "", "description": "Id of target named account list. Required, string." } ] }, "description": "> **Changes data.** Sending this request removes records or associations in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nRemoves named account members from a named account list. Required Permissions: Read-Write Named Account\n\n- **Endpoint:** `POST /rest/v1/namedAccountList/{id}/namedAccounts/remove.json`\n- **Operation ID:** `removeNamedAccountListMembersUsingPOST`\n- **API:** Core API · Named Account Lists\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Remove Named Account List Members on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/named-account-lists/remove-named-account-list-members/)\n\n### Parameters\n\n- `id` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [RemoveNamedAccountListMemberRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/removenamedaccountlistmemberrequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `input` · array of NamedAccount · required — List of input records.\n- `input[].marketoGUID` · string · optional — Unique GUID of the custom object records.\n- `input[].reasons` · array of Reason · optional · returned in responses; do not send — List of reasons why an operation did not succeed. Reasons are only present in API responses and should not be submitted.\n- `input[].reasons[].code` · string · required — Integer code of the reason.\n- `input[].reasons[].message` · string · required — Message describing the reason for the status of the operation.\n- `input[].seq` · integer (int32) · optional · returned in responses; do not send — Integer indicating the sequence of the record in response. This value is correlated to the order of the records included in the request input. Seq should only be part of responses and should not be submitted.\n- `input[].status` · string · optional — Not documented in the source specification. Allowed values: `created`, `updated`, `deleted`, `skipped`, `added`, `removed`.\n\n### Responses\n\n- `200` — OK · [ResponseOfNamedAccount](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofnamedaccount/)\n\nDeclared response media type: `application/json`." } }, { "id": "f63370ab-6480-557d-b293-68821ba7d3a9", "name": "GET · Get Named Account Lists", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/namedAccountLists.json?filterType=&filterValues=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "namedAccountLists.json" ], "query": [ { "key": "filterType", "value": "", "description": "The named account list field to filter on (\"dedupeFields\" or \"idFields\"). Required, string." }, { "key": "filterValues", "value": "", "description": "Comma-separated list of values to match against. Required, array of string. Comma-separated list in a single value, e.g. a,b,c." }, { "key": "batchSize", "value": "", "description": "The batch size to return. The max and default value is 300. Optional, integer (int32).", "disabled": true }, { "key": "nextPageToken", "value": "", "description": "A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info. Optional, string.", "disabled": true } ] }, "description": "Retrieves a list of named account list records based on the filter type and values given. Required Permissions: Read-Only Named Account List, Read-Write Named Account List\n\n- **Endpoint:** `GET /rest/v1/namedAccountLists.json`\n- **Operation ID:** `getNamedAccountListsUsingGET`\n- **API:** Core API · Named Account Lists\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Named Account Lists on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/named-account-lists/get-named-account-lists/)\n\n### Parameters\n\n- `filterType` · query param · string · required\n- `filterValues` · query param · array of string · required\n- `batchSize` · query param · integer (int32) · optional\n- `nextPageToken` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfNamedAccountList](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofnamedaccountlist/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n1. Send this request. If the response has `moreResult` set to `true`, copy the `nextPageToken` from the response into the `nextPageToken` param, and send the request again.\n2. Stop when `moreResult` is `false`.\n3. `batchSize` sets the maximum number of records per response.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "d7dd7e29-5fac-5646-aec1-6fe526716523", "name": "POST · Sync Named Account Lists", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"input\": []\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/namedAccountLists.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "namedAccountLists.json" ] }, "description": "> **Changes data.** Sending this request creates or updates records in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nCreates and/or updates named account list records. Required Permissions: Read-Write Named Account List\n\n- **Endpoint:** `POST /rest/v1/namedAccountLists.json`\n- **Operation ID:** `syncNamedAccountListsUsingPOST`\n- **API:** Core API · Named Account Lists\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Sync Named Account Lists on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/named-account-lists/sync-named-account-lists/)\n\n### Request body\n\n`application/json` · required · model [SyncNamedAccountListRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/syncnamedaccountlistrequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `action` · string · optional — Type of sync operation to perform. Allowed values: `createOnly`, `updateOnly`.\n- `dedupeBy` · string · optional — Field to deduplicate on. If the value in the field for a given record is not unique, an error will be returned for the individual record.\n- `input` · array of NamedAccountList · required — List of input records.\n- `input[].createdAt` · string · optional — Datetime when the named account list was created.\n- `input[].marketoGUID` · string · optional — Unique GUID of the custom object records.\n- `input[].name` · string · optional — Name of named account list.\n- `input[].reasons` · array of Reason · optional · returned in responses; do not send — List of reasons why an operation did not succeed. Reasons are only present in API responses and should not be submitted.\n- `input[].reasons[].code` · string · required — Integer code of the reason.\n- `input[].reasons[].message` · string · required — Message describing the reason for the status of the operation.\n- `input[].seq` · integer (int32) · optional · returned in responses; do not send — Integer indicating the sequence of the record in response. This value is correlated to the order of the records included in the request input. Seq should only be part of responses and should not be submitted.\n- `input[].status` · string · optional — Not documented in the source specification. Allowed values: `created`, `updated`, `deleted`, `skipped`, `added`, `removed`.\n- `input[].type` · string · optional — Type of named account list (\"default\" if created by user or API, \"external\" if managed by CRM-View)\n- `input[].updateable` · boolean · optional — Whether the list is updateable (true if created by user or API, false if managed by CRM-View)\n- `input[].updatedAt` · string · optional — Datetime when the named account list was most recently updated.\n\n### Responses\n\n- `200` — OK · [ResponseOfNamedAccountList](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofnamedaccountlist/)\n\nDeclared response media type: `application/json`." } }, { "id": "f40a6f7e-3e93-54d1-b8ac-0b1ca888f049", "name": "POST · Delete Named Account Lists", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"input\": []\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/namedAccountLists/delete.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "namedAccountLists", "delete.json" ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDelete named account lists by dedupe fields, or by id field. Required Permissions: Read-Write Named Account List\n\n- **Endpoint:** `POST /rest/v1/namedAccountLists/delete.json`\n- **Operation ID:** `deleteNamedAccountListsUsingPOST`\n- **API:** Core API · Named Account Lists\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete Named Account Lists on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/named-account-lists/delete-named-account-lists/)\n\n### Request body\n\n`application/json` · required · model [DeleteNamedAccountListRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/deletenamedaccountlistrequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `deleteBy` · string · optional — Key to use for deletion of the record.\n- `input` · array of NamedAccountList · required — List of input records.\n- `input[].createdAt` · string · optional — Datetime when the named account list was created.\n- `input[].marketoGUID` · string · optional — Unique GUID of the custom object records.\n- `input[].name` · string · optional — Name of named account list.\n- `input[].reasons` · array of Reason · optional · returned in responses; do not send — List of reasons why an operation did not succeed. Reasons are only present in API responses and should not be submitted.\n- `input[].reasons[].code` · string · required — Integer code of the reason.\n- `input[].reasons[].message` · string · required — Message describing the reason for the status of the operation.\n- `input[].seq` · integer (int32) · optional · returned in responses; do not send — Integer indicating the sequence of the record in response. This value is correlated to the order of the records included in the request input. Seq should only be part of responses and should not be submitted.\n- `input[].status` · string · optional — Not documented in the source specification. Allowed values: `created`, `updated`, `deleted`, `skipped`, `added`, `removed`.\n- `input[].type` · string · optional — Type of named account list (\"default\" if created by user or API, \"external\" if managed by CRM-View)\n- `input[].updateable` · boolean · optional — Whether the list is updateable (true if created by user or API, false if managed by CRM-View)\n- `input[].updatedAt` · string · optional — Datetime when the named account list was most recently updated.\n\n### Responses\n\n- `200` — OK · [ResponseOfNamedAccountList](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofnamedaccountlist/)\n\nDeclared response media type: `application/json`." } } ] }, { "id": "8288b609-d230-55f8-a473-ae16251da032", "name": "Named Accounts", "description": "Named Accounts operations in the Core API. Reference: [Named Accounts](https://mkto-ref.harrisonjennings.au/reference/core/named-accounts/).", "item": [ { "id": "26e65006-4867-508b-90d1-3e04551ac75a", "name": "GET · Get Named Account Field by Name", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/namedaccounts/schema/fields/:fieldApiName.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "namedaccounts", "schema", "fields", ":fieldApiName.json" ], "variable": [ { "key": "fieldApiName", "value": "", "description": "The API name of named account field. Required, string." } ] }, "description": "Retrieves metadata for single named account field. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field\n\n- **Endpoint:** `GET /rest/v1/namedaccounts/schema/fields/{fieldApiName}.json`\n- **Operation ID:** `getNamedAccountFieldByNameUsingGET`\n- **API:** Core API · Named Accounts\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Named Account Field by Name on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/named-accounts/get-named-account-field-by-name/)\n\n### Parameters\n\n- `fieldApiName` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLeadField](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofleadfield/)\n\nDeclared response media type: `application/json`." } }, { "id": "db32337e-2db1-56bb-874c-04a72de8a437", "name": "GET · Get Named Account Fields", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/namedaccounts/schema/fields.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "namedaccounts", "schema", "fields.json" ], "query": [ { "key": "batchSize", "value": "", "description": "The batch size to return. The max and default value is 300. Optional, integer (int32).", "disabled": true }, { "key": "nextPageToken", "value": "", "description": "A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info. Optional, string.", "disabled": true } ] }, "description": "Retrieves metadata for all named account fields in the target instance. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field\n\n- **Endpoint:** `GET /rest/v1/namedaccounts/schema/fields.json`\n- **Operation ID:** `getNamedAccountFieldsUsingGET`\n- **API:** Core API · Named Accounts\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Named Account Fields on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/named-accounts/get-named-account-fields/)\n\n### Parameters\n\n- `batchSize` · query param · integer (int32) · optional\n- `nextPageToken` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLeadField](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofleadfield/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n1. Send this request. If the response has `moreResult` set to `true`, copy the `nextPageToken` from the response into the `nextPageToken` param, and send the request again.\n2. Stop when `moreResult` is `false`.\n3. `batchSize` sets the maximum number of records per response.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "ee599b82-f630-5c00-810b-0d0785709a8d", "name": "GET · Get NamedAccounts", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/namedaccounts.json?filterType=&filterValues=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "namedaccounts.json" ], "query": [ { "key": "filterType", "value": "", "description": "NamedAccounts field to filter on. Can be any searchable fields. Required, string." }, { "key": "filterValues", "value": "", "description": "A comma-separated list of values to match against. Required, array of string. Comma-separated list in a single value, e.g. a,b,c." }, { "key": "fields", "value": "", "description": "Comma-separated list of fields to include in the response. Optional, array of string. Comma-separated list in a single value, e.g. a,b,c.", "disabled": true }, { "key": "batchSize", "value": "", "description": "The batch size to return. The max and default value is 300. Optional, integer (int32).", "disabled": true }, { "key": "nextPageToken", "value": "", "description": "A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info. Optional, string.", "disabled": true } ] }, "description": "Retrieves namedaccount records from the destination instance based on the submitted filter. Required Permissions: Read-Only Named Account, Read-Write Named Account\n\n- **Endpoint:** `GET /rest/v1/namedaccounts.json`\n- **Operation ID:** `getNamedAccountsUsingGET`\n- **API:** Core API · Named Accounts\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get NamedAccounts on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/named-accounts/get-namedaccounts/)\n\n### Parameters\n\n- `filterType` · query param · string · required\n- `filterValues` · query param · array of string · required\n- `fields` · query param · array of string · optional\n- `batchSize` · query param · integer (int32) · optional\n- `nextPageToken` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfNamedAccount](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofnamedaccount/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n1. Send this request. If the response has `moreResult` set to `true`, copy the `nextPageToken` from the response into the `nextPageToken` param, and send the request again.\n2. Stop when `moreResult` is `false`.\n3. `batchSize` sets the maximum number of records per response.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "13ee2917-0b7a-5ed0-8fe1-fab689efde17", "name": "POST · Sync NamedAccounts", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"input\": []\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/namedaccounts.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "namedaccounts.json" ] }, "description": "> **Changes data.** Sending this request creates or updates records in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nAllows inserts, updates, or upserts of namedaccounts to the target instance. Required Permissions: Read-Write Named Account\n\n- **Endpoint:** `POST /rest/v1/namedaccounts.json`\n- **Operation ID:** `syncNamedAccountsUsingPOST`\n- **API:** Core API · Named Accounts\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Sync NamedAccounts on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/named-accounts/sync-namedaccounts/)\n\n### Request body\n\n`application/json` · required · model [SyncNamedAccountRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/syncnamedaccountrequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `action` · string · optional — Type of sync operation to perform. Allowed values: `createOnly`, `updateOnly`, `createOrUpdate`.\n- `dedupeBy` · string · optional — Field to deduplicate on. If the value in the field for a given record is not unique, an error will be returned for the individual record.\n- `input` · array of NamedAccount · required — List of input records.\n- `input[].marketoGUID` · string · optional — Unique GUID of the custom object records.\n- `input[].reasons` · array of Reason · optional · returned in responses; do not send — List of reasons why an operation did not succeed. Reasons are only present in API responses and should not be submitted.\n- `input[].reasons[].code` · string · required — Integer code of the reason.\n- `input[].reasons[].message` · string · required — Message describing the reason for the status of the operation.\n- `input[].seq` · integer (int32) · optional · returned in responses; do not send — Integer indicating the sequence of the record in response. This value is correlated to the order of the records included in the request input. Seq should only be part of responses and should not be submitted.\n- `input[].status` · string · optional — Not documented in the source specification. Allowed values: `created`, `updated`, `deleted`, `skipped`, `added`, `removed`.\n\n### Responses\n\n- `200` — OK · [ResponseOfNamedAccount](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofnamedaccount/)\n\nDeclared response media type: `application/json`." } }, { "id": "06826d38-963a-5d54-a89c-b96a153a74f4", "name": "POST · Delete NamedAccounts", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"input\": []\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/namedaccounts/delete.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "namedaccounts", "delete.json" ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDeletes a list of namedaccount records from the target instance. Input records should have only one member, based on the value of 'dedupeBy'. Required Permissions: Read-Write Named Account\n\n- **Endpoint:** `POST /rest/v1/namedaccounts/delete.json`\n- **Operation ID:** `deleteNamedAccountsUsingPOST`\n- **API:** Core API · Named Accounts\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete NamedAccounts on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/named-accounts/delete-namedaccounts/)\n\n### Request body\n\n`application/json` · required · model [DeleteNamedAccountRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/deletenamedaccountrequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `deleteBy` · string · optional — Key to use for deletion of the record.\n- `input` · array of NamedAccount · required — List of input records.\n- `input[].marketoGUID` · string · optional — Unique GUID of the custom object records.\n- `input[].reasons` · array of Reason · optional · returned in responses; do not send — List of reasons why an operation did not succeed. Reasons are only present in API responses and should not be submitted.\n- `input[].reasons[].code` · string · required — Integer code of the reason.\n- `input[].reasons[].message` · string · required — Message describing the reason for the status of the operation.\n- `input[].seq` · integer (int32) · optional · returned in responses; do not send — Integer indicating the sequence of the record in response. This value is correlated to the order of the records included in the request input. Seq should only be part of responses and should not be submitted.\n- `input[].status` · string · optional — Not documented in the source specification. Allowed values: `created`, `updated`, `deleted`, `skipped`, `added`, `removed`.\n\n### Responses\n\n- `200` — OK · [ResponseOfNamedAccount](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofnamedaccount/)\n\nDeclared response media type: `application/json`." } }, { "id": "cf488cbb-9aa6-5e4c-aa4f-2eab86745542", "name": "GET · Describe NamedAccounts", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/namedaccounts/describe.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "namedaccounts", "describe.json" ] }, "description": "Returns metadata about namedaccounts and the fields available for interaction via the API. Required Permissions: Read-Only Named Account, Read-Write Named Account\n\n- **Endpoint:** `GET /rest/v1/namedaccounts/describe.json`\n- **Operation ID:** `describeUsingGET_3`\n- **API:** Core API · Named Accounts\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Describe NamedAccounts on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/named-accounts/describe-namedaccounts/)\n\n### Responses\n\n- `200` — OK · [ResponseOfObjectMetaData](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofobjectmetadata/)\n\nDeclared response media type: `application/json`." } } ] }, { "id": "908317c8-c3dd-5f99-a323-da457763c1e1", "name": "Opportunities", "description": "Opportunities operations in the Core API. Reference: [Opportunities](https://mkto-ref.harrisonjennings.au/reference/core/opportunities/).", "item": [ { "id": "b0177852-3c24-5d65-a8bd-c0b0cc01db3f", "name": "GET · Get Opportunity Field by Name", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/opportunities/schema/fields/:fieldApiName.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "opportunities", "schema", "fields", ":fieldApiName.json" ], "variable": [ { "key": "fieldApiName", "value": "", "description": "The API name of opportunity field. Required, string." } ] }, "description": "Retrieves metadata for single opportunity field. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field\n\n- **Endpoint:** `GET /rest/v1/opportunities/schema/fields/{fieldApiName}.json`\n- **Operation ID:** `getOpportunityFieldByNameUsingGET`\n- **API:** Core API · Opportunities\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Opportunity Field by Name on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/opportunities/get-opportunity-field-by-name/)\n\n### Parameters\n\n- `fieldApiName` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLeadField](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofleadfield/)\n\nDeclared response media type: `application/json`." } }, { "id": "a1d27a89-a476-5b3e-a1a0-9adb411035f1", "name": "GET · Get Opportunity Fields", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/opportunities/schema/fields.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "opportunities", "schema", "fields.json" ], "query": [ { "key": "batchSize", "value": "", "description": "The batch size to return. The max and default value is 300. Optional, integer (int32).", "disabled": true }, { "key": "nextPageToken", "value": "", "description": "A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info. Optional, string.", "disabled": true } ] }, "description": "Retrieves metadata for all opportunity fields in the target instance. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field\n\n- **Endpoint:** `GET /rest/v1/opportunities/schema/fields.json`\n- **Operation ID:** `getOpportunityFieldsUsingGET`\n- **API:** Core API · Opportunities\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Opportunity Fields on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/opportunities/get-opportunity-fields/)\n\n### Parameters\n\n- `batchSize` · query param · integer (int32) · optional\n- `nextPageToken` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLeadField](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofleadfield/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n1. Send this request. If the response has `moreResult` set to `true`, copy the `nextPageToken` from the response into the `nextPageToken` param, and send the request again.\n2. Stop when `moreResult` is `false`.\n3. `batchSize` sets the maximum number of records per response.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "a3d3e1d3-ee15-525c-abd2-231d287ab76c", "name": "GET · Get Opportunities", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/opportunities.json?filterType=&filterValues=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "opportunities.json" ], "query": [ { "key": "filterType", "value": "", "description": "Opportunities field to filter on. Required, string." }, { "key": "filterValues", "value": "", "description": "Comma-separated list of values to match against. Required, array of string. Comma-separated list in a single value, e.g. a,b,c." }, { "key": "fields", "value": "", "description": "Comma-separated list of fields to include in the response. Optional, array of string. Comma-separated list in a single value, e.g. a,b,c.", "disabled": true }, { "key": "batchSize", "value": "", "description": "Maximum number of records to return in the response. Max and default is 300. Optional, integer (int32).", "disabled": true }, { "key": "nextPageToken", "value": "", "description": "Paging token returned from a previous response. Optional, string.", "disabled": true } ] }, "description": "Returns a list of opportunities based on a filter and set of values. Required Permissions: Read-Only Opportunity, Read-Write Named Opportunity\n\n- **Endpoint:** `GET /rest/v1/opportunities.json`\n- **Operation ID:** `getOpportunitiesUsingGET`\n- **API:** Core API · Opportunities\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Opportunities on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/opportunities/get-opportunities/)\n\n### Parameters\n\n- `filterType` · query param · string · required\n- `filterValues` · query param · array of string · required\n- `fields` · query param · array of string · optional\n- `batchSize` · query param · integer (int32) · optional\n- `nextPageToken` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · optional · model [LookupCustomObjectRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/lookupcustomobjectrequest/)\n\nThis body is optional and starts empty, so the request is sent without one. If you add a body, Postman sends it with this GET request (body pruning is disabled for it).\n\n**Properties**\n\n- `batchSize` · integer (int32) · optional — Maximum number of records to return in the response. Max and default is 300.\n- `fields` · array of string · optional — List of fields to return. If not specified, will return the following fields: marketoGuid, dedupeFields, updatedAt, createdAt, filterType.\n- `filterType` · string · optional — Field to search on. Valid values are: dedupeFields, idFields, and any field defined in searchableFields attribute of Describe endpoint. Default is dedupeFields.\n- `input` · array of CustomObject · required — Search values when using a compound key. Each element must include each of the fields in the compound key. Compound keys are determined by the contents of \"dedupeFields\" in the Describe result for the object.\n- `input[].marketoGUID` · string · optional — Unique GUID of the custom object records.\n- `input[].reasons` · array of Reason · optional · returned in responses; do not send — List of reasons why an operation did not succeed. Reasons are only present in API responses and should not be submitted.\n- `input[].reasons[].code` · string · required — Integer code of the reason.\n- `input[].reasons[].message` · string · required — Message describing the reason for the status of the operation.\n- `input[].seq` · integer (int32) · optional · returned in responses; do not send — Integer indicating the sequence of the record in response. This value is correlated to the order of the records included in the request input. Seq should only be part of responses and should not be submitted.\n- `nextPageToken` · string · optional — Paging token returned from a previous response.\n\n### Responses\n\n- `200` — OK · [ResponseOfCustomObject](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofcustomobject/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n1. Send this request. If the response has `moreResult` set to `true`, copy the `nextPageToken` from the response into the `nextPageToken` param, and send the request again.\n2. Stop when `moreResult` is `false`.\n3. `batchSize` sets the maximum number of records per response.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "1a24d1aa-ff91-5cb3-bcb1-0e99769fac75", "name": "POST · Sync Opportunities", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"input\": []\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/opportunities.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "opportunities.json" ] }, "description": "> **Changes data.** Sending this request creates or updates records in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nAllows inserting, updating, or upserting of opportunity records into the target instance. Required Permissions: Read-Write Named Opportunity\n\n- **Endpoint:** `POST /rest/v1/opportunities.json`\n- **Operation ID:** `syncOpportunitiesUsingPOST`\n- **API:** Core API · Opportunities\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Sync Opportunities on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/opportunities/sync-opportunities/)\n\n### Request body\n\n`application/json` · required · model [SyncCustomObjectRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/synccustomobjectrequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `action` · string · optional — Type of sync operation to perform. Allowed values: `createOnly`, `updateOnly`, `createOrUpdate`.\n- `dedupeBy` · string · optional — Field to deduplicate on. If the value in the field for a given record is not unique, an error will be returned for the individual record.\n- `input` · array of CustomObject · required — List of input records.\n- `input[].marketoGUID` · string · optional — Unique GUID of the custom object records.\n- `input[].reasons` · array of Reason · optional · returned in responses; do not send — List of reasons why an operation did not succeed. Reasons are only present in API responses and should not be submitted.\n- `input[].reasons[].code` · string · required — Integer code of the reason.\n- `input[].reasons[].message` · string · required — Message describing the reason for the status of the operation.\n- `input[].seq` · integer (int32) · optional · returned in responses; do not send — Integer indicating the sequence of the record in response. This value is correlated to the order of the records included in the request input. Seq should only be part of responses and should not be submitted.\n\n### Responses\n\n- `200` — OK · [ResponseOfCustomObject](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofcustomobject/)\n\nDeclared response media type: `application/json`." } }, { "id": "71b49f7a-8553-5ade-8ecb-cf24ae214737", "name": "POST · Delete Opportunities", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"input\": []\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/opportunities/delete.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "opportunities", "delete.json" ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDeletes a list of opportunity records from the target instance. Input records should only have one member, based on the value of 'dedupeBy'. Required Permissions: Read-Write Named Opportunity\n\n- **Endpoint:** `POST /rest/v1/opportunities/delete.json`\n- **Operation ID:** `deleteOpportunitiesUsingPOST`\n- **API:** Core API · Opportunities\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete Opportunities on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/opportunities/delete-opportunities/)\n\n### Request body\n\n`application/json` · optional · model [DeleteCustomObjectRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/deletecustomobjectrequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `deleteBy` · string · optional — Field to delete records by. Permissible values are idField or dedupeFields as indicated by the result of the corresponding describe record.\n- `input` · array of CustomObject · required — List of input records.\n- `input[].marketoGUID` · string · optional — Unique GUID of the custom object records.\n- `input[].reasons` · array of Reason · optional · returned in responses; do not send — List of reasons why an operation did not succeed. Reasons are only present in API responses and should not be submitted.\n- `input[].reasons[].code` · string · required — Integer code of the reason.\n- `input[].reasons[].message` · string · required — Message describing the reason for the status of the operation.\n- `input[].seq` · integer (int32) · optional · returned in responses; do not send — Integer indicating the sequence of the record in response. This value is correlated to the order of the records included in the request input. Seq should only be part of responses and should not be submitted.\n\n### Responses\n\n- `200` — OK · [ResponseOfCustomObject](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofcustomobject/)\n\nDeclared response media type: `application/json`." } }, { "id": "f43cf087-e5dc-5692-a39f-d29e3614b631", "name": "GET · Describe Opportunity", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/opportunities/describe.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "opportunities", "describe.json" ] }, "description": "Returns object and field metadata for Opportunity type records in the target instance. Required Permissions: Read-Only Opportunity, Read-Write Named Opportunity\n\n- **Endpoint:** `GET /rest/v1/opportunities/describe.json`\n- **Operation ID:** `describeUsingGET_4`\n- **API:** Core API · Opportunities\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Describe Opportunity on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/opportunities/describe-opportunity/)\n\n### Responses\n\n- `200` — OK · [ResponseOfObjectMetaData](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofobjectmetadata/)\n\nDeclared response media type: `application/json`." } }, { "id": "0d055b48-58fc-5377-bc91-90e80aed7455", "name": "GET · Get Opportunity Roles", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/opportunities/roles.json?filterType=&filterValues=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "opportunities", "roles.json" ], "query": [ { "key": "filterType", "value": "", "description": "The role field to filter on. Searchable fields can be retrieved with the Describe Opportunity call. Required, string." }, { "key": "filterValues", "value": "", "description": "Comma-separated list of field values to return records for. Required, array of string. Comma-separated list in a single value, e.g. a,b,c." }, { "key": "fields", "value": "", "description": "Comma-separated list of fields to include in the response. Optional, array of string. Comma-separated list in a single value, e.g. a,b,c.", "disabled": true }, { "key": "batchSize", "value": "", "description": "Maximum number of records to return in the response. Max and default is 300. Optional, integer (int32).", "disabled": true }, { "key": "nextPageToken", "value": "", "description": "Paging token returned from a previous response. Optional, string.", "disabled": true } ] }, "description": "Returns a list of opportunity roles based on a filter and set of values. Required Permissions: Read-Only Opportunity, Read-Write Named Opportunity\n\n- **Endpoint:** `GET /rest/v1/opportunities/roles.json`\n- **Operation ID:** `getOpportunityRolesUsingGET`\n- **API:** Core API · Opportunities\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Opportunity Roles on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/opportunities/get-opportunity-roles/)\n\n### Parameters\n\n- `filterType` · query param · string · required\n- `filterValues` · query param · array of string · required\n- `fields` · query param · array of string · optional\n- `batchSize` · query param · integer (int32) · optional\n- `nextPageToken` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · optional · model [LookupCustomObjectRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/lookupcustomobjectrequest/)\n\nOptional JSON request for retrieving opportunity roles with compound keys\n\nThis body is optional and starts empty, so the request is sent without one. If you add a body, Postman sends it with this GET request (body pruning is disabled for it).\n\n**Properties**\n\n- `batchSize` · integer (int32) · optional — Maximum number of records to return in the response. Max and default is 300.\n- `fields` · array of string · optional — List of fields to return. If not specified, will return the following fields: marketoGuid, dedupeFields, updatedAt, createdAt, filterType.\n- `filterType` · string · optional — Field to search on. Valid values are: dedupeFields, idFields, and any field defined in searchableFields attribute of Describe endpoint. Default is dedupeFields.\n- `input` · array of CustomObject · required — Search values when using a compound key. Each element must include each of the fields in the compound key. Compound keys are determined by the contents of \"dedupeFields\" in the Describe result for the object.\n- `input[].marketoGUID` · string · optional — Unique GUID of the custom object records.\n- `input[].reasons` · array of Reason · optional · returned in responses; do not send — List of reasons why an operation did not succeed. Reasons are only present in API responses and should not be submitted.\n- `input[].reasons[].code` · string · required — Integer code of the reason.\n- `input[].reasons[].message` · string · required — Message describing the reason for the status of the operation.\n- `input[].seq` · integer (int32) · optional · returned in responses; do not send — Integer indicating the sequence of the record in response. This value is correlated to the order of the records included in the request input. Seq should only be part of responses and should not be submitted.\n- `nextPageToken` · string · optional — Paging token returned from a previous response.\n\n### Responses\n\n- `200` — OK · [ResponseOfCustomObject](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofcustomobject/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n1. Send this request. If the response has `moreResult` set to `true`, copy the `nextPageToken` from the response into the `nextPageToken` param, and send the request again.\n2. Stop when `moreResult` is `false`.\n3. `batchSize` sets the maximum number of records per response.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "25fb4e46-a054-53ce-aac1-79a7c84b55d9", "name": "POST · Sync Opportunity Roles", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"input\": []\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/opportunities/roles.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "opportunities", "roles.json" ] }, "description": "> **Changes data.** Sending this request creates or updates records in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nAllows inserts, updates and upserts of Opportunity Role records in the target instance. Required Permissions: Read-Write Named Opportunity\n\n- **Endpoint:** `POST /rest/v1/opportunities/roles.json`\n- **Operation ID:** `syncOpportunityRolesUsingPOST`\n- **API:** Core API · Opportunities\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Sync Opportunity Roles on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/opportunities/sync-opportunity-roles/)\n\n### Request body\n\n`application/json` · required · model [SyncCustomObjectRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/synccustomobjectrequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `action` · string · optional — Type of sync operation to perform. Allowed values: `createOnly`, `updateOnly`, `createOrUpdate`.\n- `dedupeBy` · string · optional — Field to deduplicate on. If the value in the field for a given record is not unique, an error will be returned for the individual record.\n- `input` · array of CustomObject · required — List of input records.\n- `input[].marketoGUID` · string · optional — Unique GUID of the custom object records.\n- `input[].reasons` · array of Reason · optional · returned in responses; do not send — List of reasons why an operation did not succeed. Reasons are only present in API responses and should not be submitted.\n- `input[].reasons[].code` · string · required — Integer code of the reason.\n- `input[].reasons[].message` · string · required — Message describing the reason for the status of the operation.\n- `input[].seq` · integer (int32) · optional · returned in responses; do not send — Integer indicating the sequence of the record in response. This value is correlated to the order of the records included in the request input. Seq should only be part of responses and should not be submitted.\n\n### Responses\n\n- `200` — OK · [ResponseOfCustomObject](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofcustomobject/)\n\nDeclared response media type: `application/json`." } }, { "id": "2ed4eab7-8d6f-50e2-892c-b3f84ffa1a71", "name": "POST · Delete Opportunity Roles", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"input\": []\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/opportunities/roles/delete.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "opportunities", "roles", "delete.json" ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDeletes a list of opportunities from the target instance. Required Permissions: Read-Write Named Opportunity\n\n- **Endpoint:** `POST /rest/v1/opportunities/roles/delete.json`\n- **Operation ID:** `deleteOpportunityRolesUsingPOST`\n- **API:** Core API · Opportunities\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete Opportunity Roles on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/opportunities/delete-opportunity-roles/)\n\n### Request body\n\n`application/json` · optional · model [DeleteCustomObjectRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/deletecustomobjectrequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `deleteBy` · string · optional — Field to delete records by. Permissible values are idField or dedupeFields as indicated by the result of the corresponding describe record.\n- `input` · array of CustomObject · required — List of input records.\n- `input[].marketoGUID` · string · optional — Unique GUID of the custom object records.\n- `input[].reasons` · array of Reason · optional · returned in responses; do not send — List of reasons why an operation did not succeed. Reasons are only present in API responses and should not be submitted.\n- `input[].reasons[].code` · string · required — Integer code of the reason.\n- `input[].reasons[].message` · string · required — Message describing the reason for the status of the operation.\n- `input[].seq` · integer (int32) · optional · returned in responses; do not send — Integer indicating the sequence of the record in response. This value is correlated to the order of the records included in the request input. Seq should only be part of responses and should not be submitted.\n\n### Responses\n\n- `200` — OK · [ResponseOfCustomObject](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofcustomobject/)\n\nDeclared response media type: `application/json`." } }, { "id": "d072625f-ba93-5394-8521-1c16a84ab371", "name": "GET · Describe Opportunity Role", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/opportunities/roles/describe.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "opportunities", "roles", "describe.json" ] }, "description": "Returns object and field metadata for Opportunity Roles in the target instance. Required Permissions: Read-Only Opportunity, Read-Write Named Opportunity\n\n- **Endpoint:** `GET /rest/v1/opportunities/roles/describe.json`\n- **Operation ID:** `describeOpportunityRoleUsingGET`\n- **API:** Core API · Opportunities\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Describe Opportunity Role on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/opportunities/describe-opportunity-role/)\n\n### Responses\n\n- `200` — OK · [ResponseOfObjectMetaData](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofobjectmetadata/)\n\nDeclared response media type: `application/json`." } } ] }, { "id": "4d9ebe42-d9c6-5383-9e17-af2731fb28df", "name": "Program Members", "description": "Program Members operations in the Core API. Reference: [Program Members](https://mkto-ref.harrisonjennings.au/reference/core/program-members/).", "item": [ { "id": "edffc59d-46e5-5747-ad4a-1858e5395399", "name": "GET · Get Program Member Field by Name", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/programs/members/schema/fields/:fieldApiName.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "programs", "members", "schema", "fields", ":fieldApiName.json" ], "variable": [ { "key": "fieldApiName", "value": "", "description": "The API name of program member field. Required, string." } ] }, "description": "Retrieves metadata for single program member field. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field\n\n- **Endpoint:** `GET /rest/v1/programs/members/schema/fields/{fieldApiName}.json`\n- **Operation ID:** `getProgramMemberFieldByNameUsingGET`\n- **API:** Core API · Program Members\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Program Member Field by Name on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/program-members/get-program-member-field-by-name/)\n\n### Parameters\n\n- `fieldApiName` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLeadField](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofleadfield/)\n\nDeclared response media type: `application/json`." } }, { "id": "bb7848c5-f700-5371-b3fc-1e31b926838f", "name": "POST · Update Program Member Field", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"input\": []\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/programs/members/schema/fields/:fieldApiName.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "programs", "members", "schema", "fields", ":fieldApiName.json" ], "variable": [ { "key": "fieldApiName", "value": "", "description": "The API name of program member field. Required, string." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdate metadata for a program member field in the target instance. See update rules [here](https://developers.marketo.com/rest-api/lead-database/leads/#update_field). Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field\n\n- **Endpoint:** `POST /rest/v1/programs/members/schema/fields/{fieldApiName}.json`\n- **Operation ID:** `updateProgramMemberFieldUsingPOST`\n- **API:** Core API · Program Members\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update Program Member Field on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/program-members/update-program-member-field/)\n\n### Parameters\n\n- `fieldApiName` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [UpdateLeadFieldRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/updateleadfieldrequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `input` · array of UpdateLeadField · required — Single lead field for input.\n- `input[].displayName` · string · optional — UI display-name of the field.\n- `input[].description` · string · optional — Description of the field.\n- `input[].isHidden` · boolean · optional — If set to true, the field is hidden. Default is false.\n- `input[].isHtmlEncodingInEmail` · boolean · optional — If set to true, field is encoded as HTML in email. Default is true.\n- `input[].isSensitive` · boolean · optional — If set to true, field is marked as sensitive. Default is false.\n\n### Responses\n\n- `200` — OK · [ResponseOfUpdateLeadField](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofupdateleadfield/)\n\nDeclared response media type: `application/json`." } }, { "id": "132ee1ca-f3bb-5c45-af0a-dfbe8a4665a0", "name": "GET · Get Program Member Fields", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/programs/members/schema/fields.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "programs", "members", "schema", "fields.json" ], "query": [ { "key": "batchSize", "value": "", "description": "The batch size to return. The max and default value is 300. Optional, integer (int32).", "disabled": true }, { "key": "nextPageToken", "value": "", "description": "A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info. Optional, string.", "disabled": true } ] }, "description": "Retrieves metadata for all program member fields in the target instance. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field\n\n- **Endpoint:** `GET /rest/v1/programs/members/schema/fields.json`\n- **Operation ID:** `getProgramMemberFieldsUsingGET`\n- **API:** Core API · Program Members\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Program Member Fields on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/program-members/get-program-member-fields/)\n\n### Parameters\n\n- `batchSize` · query param · integer (int32) · optional\n- `nextPageToken` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLeadField](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofleadfield/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n1. Send this request. If the response has `moreResult` set to `true`, copy the `nextPageToken` from the response into the `nextPageToken` param, and send the request again.\n2. Stop when `moreResult` is `false`.\n3. `batchSize` sets the maximum number of records per response.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "1eb8284b-1e5a-5300-916b-8aa1706d1d24", "name": "POST · Create Program Member Fields", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"displayName\": null,\n \"name\": null,\n \"dataType\": null\n }\n ]\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/programs/members/schema/fields.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "programs", "members", "schema", "fields.json" ] }, "description": "> **Changes data.** Sending this request creates data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nCreate program member fields in the target instance. Required Permissions: Read-Write Schema Custom Field\n\n- **Endpoint:** `POST /rest/v1/programs/members/schema/fields.json`\n- **Operation ID:** `createProgramMemberFieldUsingPOST`\n- **API:** Core API · Program Members\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Create Program Member Fields on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/program-members/create-program-member-fields/)\n\n### Request body\n\n`application/json` · required · model [CreateLeadFieldRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/createleadfieldrequest/)\n\nThe body starts with the required properties only, set to `null`. Replace each `null` with a value, and add any optional properties you need.\n\n**Properties**\n\n- `input` · array of CreateLeadField · required — List of lead fields for input.\n- `input[].displayName` · string · required — UI display-name of the field. Must be unique, cannot contain special characters.\n- `input[].name` · string · required — API name of the field. Must be unique, start with a letter, and only contain letters, numbers, or underscore.\n- `input[].description` · string · optional — Description of the field. Default is no description.\n- `input[].dataType` · string · required — Datatype of the field. Allowed values: `boolean`, `currency`, `date`, `datetime`, `email`, `float`, `integer`, `percent`, `phone`, `score`, `string`, `url`.\n- `input[].isHidden` · boolean · optional — If set to true, the field is hidden. Default is false.\n- `input[].isHtmlEncodingInEmail` · boolean · optional — If set to true, field is encoded as HTML in email. Default is true.\n- `input[].isSensitive` · boolean · optional — If set to true, field is marked as sensitive. Default is false.\n\n### Responses\n\n- `200` — OK · [ResponseOfCreateLeadField](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofcreateleadfield/)\n\nDeclared response media type: `application/json`." } }, { "id": "247b0c30-0351-5e70-8493-f191aecc8398", "name": "POST · Sync Program Member Status", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"statusName\": null,\n \"input\": [\n {\n \"leadId\": null\n }\n ]\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/programs/:programId/members/status.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "programs", ":programId", "members", "status.json" ], "variable": [ { "key": "programId", "value": "", "description": "The id of target program. Required, integer (int64)." } ] }, "description": "> **Changes data.** Sending this request creates or updates records in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nChanges the program member status of a list of leads in a target program. If member is not part of the program, member is added to the program. Required Permissions: Read-Write Lead\n\n- **Endpoint:** `POST /rest/v1/programs/{programId}/members/status.json`\n- **Operation ID:** `syncProgramMemberStatusUsingPOST`\n- **API:** Core API · Program Members\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Sync Program Member Status on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/program-members/sync-program-member-status/)\n\n### Parameters\n\n- `programId` · path variable · integer (int64) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [SyncProgramMemberStatusRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/syncprogrammemberstatusrequest/)\n\nThe body starts with the required properties only, set to `null`. Replace each `null` with a value, and add any optional properties you need.\n\n**Properties**\n\n- `statusName` · string · required — Program member status.\n- `input` · array of ProgramMemberStatus · required — List of input records.\n- `input[].leadId` · integer (int64) · required — Unique integer id of a lead record.\n\n### Responses\n\n- `200` — OK · [ResponseOfProgramMemberStatus](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofprogrammemberstatus/)\n\nDeclared response media type: `application/json`." } }, { "id": "f94c365f-a3ae-5127-81ed-218d2309e732", "name": "GET · Get Program Members", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/programs/:programId/members.json?filterType=&filterValues=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "programs", ":programId", "members.json" ], "query": [ { "key": "filterType", "value": "", "description": "The program member field to filter on. Any custom field (string or integer types only), \"updatedAt\", or any searchable field. Searchable fields can be obtained via the Describe Program Member (https://developers.marketo.com/rest-api/endpoint-reference/lead-database-endpoint-reference/#/Leads/describeProgramMemberUsingGET2) endpoint. Required, string." }, { "key": "filterValues", "value": "", "description": "A comma-separated list of values to filter on in the specified fields. Required, array of string. Comma-separated list in a single value, e.g. a,b,c." }, { "key": "startAt", "value": "", "description": "When using filterType=updatedAt, the start of date range filter (ISO 8601-format) Optional, string.", "disabled": true }, { "key": "endAt", "value": "", "description": "When using filterType=updatedAt, the end of date range filter (ISO 8601-format) Optional, string.", "disabled": true }, { "key": "fields", "value": "", "description": "A comma-separated list of lead fields to return for each record. Optional, array of string. Comma-separated list in a single value, e.g. a,b,c.", "disabled": true }, { "key": "batchSize", "value": "", "description": "The batch size to return. The max and default value is 300. Optional, integer (int32).", "disabled": true }, { "key": "nextPageToken", "value": "", "description": "A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info. Optional, string.", "disabled": true } ], "variable": [ { "key": "programId", "value": "", "description": "The id of target program. Required, integer (int64)." } ] }, "description": "Returns a list of up to 300 program members on a list of values in a particular field. If you specify a filterType that is a custom field, the custom field’s dataType must be either “string” or “integer”. If you specify a filterType other than “leadId”, a maximum of 100,000 program member records can be processed by the request. Required Permissions: Read-Only Lead, Read-Write Lead\n\n- **Endpoint:** `GET /rest/v1/programs/{programId}/members.json`\n- **Operation ID:** `getProgramMembersUsingGET`\n- **API:** Core API · Program Members\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Program Members on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/program-members/get-program-members/)\n\n### Parameters\n\n- `programId` · path variable · integer (int64) · required\n- `filterType` · query param · string · required\n- `filterValues` · query param · array of string · required\n- `startAt` · query param · string · optional\n- `endAt` · query param · string · optional\n- `fields` · query param · array of string · optional\n- `batchSize` · query param · integer (int32) · optional\n- `nextPageToken` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfProgramMember](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofprogrammember/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n1. Send this request. If the response has `moreResult` set to `true`, copy the `nextPageToken` from the response into the `nextPageToken` param, and send the request again.\n2. Stop when `moreResult` is `false`.\n3. `batchSize` sets the maximum number of records per response.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "101c3afb-f381-58b9-9b45-7bc007f0367e", "name": "POST · Sync Program Member Data", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"leadId\": null,\n \"{fieldApiName}\": null\n }\n ]\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/programs/:programId/members.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "programs", ":programId", "members.json" ], "variable": [ { "key": "programId", "value": "", "description": "The id of target program. Required, integer (int64)." } ] }, "description": "> **Changes data.** Sending this request creates or updates records in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nChanges the program member data of a list of leads in a target program. Only existing members of the program may have their data changed with this API. Required Permissions: Read-Write Lead\n\n- **Endpoint:** `POST /rest/v1/programs/{programId}/members.json`\n- **Operation ID:** `syncProgramMemberDataUsingPOST`\n- **API:** Core API · Program Members\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Sync Program Member Data on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/program-members/sync-program-member-data/)\n\n### Parameters\n\n- `programId` · path variable · integer (int64) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [SyncProgramMemberDataRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/syncprogrammemberdatarequest/)\n\nThe body starts with the required properties only, set to `null`. Replace each `null` with a value, and add any optional properties you need.\n\n**Properties**\n\n- `input` · array of ProgramMemberData · required — List of input records.\n- `input[].leadId` · integer (int64) · required — Unique integer id of a lead record.\n- `input[].{fieldApiName}` · string · required — API Name of field to update. Must be updateable as described by [Describe Program Member](https://developers.marketo.com/rest-api/endpoint-reference/lead-database-endpoint-reference/#/Leads/describeProgramMemberUsingGET2) endpoint.\n- `input[].{fieldApiName2}` · string · optional — API Name of another field to update (and so forth). Must be updateable as described by [Describe Program Member](https://developers.marketo.com/rest-api/endpoint-reference/lead-database-endpoint-reference/#/Leads/describeProgramMemberUsingGET2) endpoint.\n\n### Responses\n\n- `200` — OK · [ResponseOfProgramMemberData](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofprogrammemberdata/)\n\nDeclared response media type: `application/json`." } }, { "id": "c1a02936-f467-59c2-8f3e-1c5cf861aa30", "name": "POST · Delete Program Members", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"leadId\": null\n }\n ]\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/programs/:programId/members/delete.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "programs", ":programId", "members", "delete.json" ], "variable": [ { "key": "programId", "value": "", "description": "The id of target program. Required, integer (int64)." } ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDelete a list of members from the destination instance. Required Permissions: Read-Write Lead\n\n- **Endpoint:** `POST /rest/v1/programs/{programId}/members/delete.json`\n- **Operation ID:** `deleteProgramMemberUsingPOST`\n- **API:** Core API · Program Members\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete Program Members on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/program-members/delete-program-members/)\n\n### Parameters\n\n- `programId` · path variable · integer (int64) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [DeleteProgramMemberRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/deleteprogrammemberrequest/)\n\nThe body starts with the required properties only, set to `null`. Replace each `null` with a value, and add any optional properties you need.\n\n**Properties**\n\n- `input` · array of ProgramMemberDelete · required — List of input records.\n- `input[].leadId` · integer (int64) · required — Unique integer id of a lead record.\n\n### Responses\n\n- `200` — OK · [ResponseOfProgramMemberDelete](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofprogrammemberdelete/)\n\nDeclared response media type: `application/json`." } }, { "id": "cc748473-6f5f-52ca-866c-d6a89aa1ce7c", "name": "GET · Describe Program Member", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/programs/members/describe.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "programs", "members", "describe.json" ] }, "description": "Returns metadata about program member objects in the target instance, including a list of all fields available for interaction via the APIs. Required Permissions: Read-Only Lead, Read-Write Lead\n\n- **Endpoint:** `GET /rest/v1/programs/members/describe.json`\n- **Operation ID:** `describeProgramMemberUsingGET2`\n- **API:** Core API · Program Members\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Describe Program Member on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/program-members/describe-program-member/)\n\n### Responses\n\n- `200` — OK · [ResponseOfProgramMemberAttributes2](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofprogrammemberattributes2/)\n\nDeclared response media type: `application/json`." } } ] }, { "id": "0ac313b9-b9c4-5d75-a9e6-9c193aea3e42", "name": "Sales Persons", "description": "Sales Persons operations in the Core API. Reference: [Sales Persons](https://mkto-ref.harrisonjennings.au/reference/core/sales-persons/).", "item": [ { "id": "d52e7269-c694-5c8f-94db-ea757e65a3ab", "name": "GET · Get SalesPersons", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/salespersons.json?filterType=&filterValues=", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "salespersons.json" ], "query": [ { "key": "filterType", "value": "", "description": "The sales person field to filter on. Searchable fields can be retrieved with the Describe Sales Person call. Required, string." }, { "key": "filterValues", "value": "", "description": "Comma separated list of search values. Required, array of string. Comma-separated list in a single value, e.g. a,b,c." }, { "key": "fields", "value": "", "description": "Comma-separated list of fields to include in the response. Optional, array of string. Comma-separated list in a single value, e.g. a,b,c.", "disabled": true }, { "key": "batchSize", "value": "", "description": "The batch size to return. The max and default value is 300. Optional, integer (int32).", "disabled": true }, { "key": "nextPageToken", "value": "", "description": "A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info. Optional, string.", "disabled": true } ] }, "description": "Retrieves salesperson records from the destination instance based on the submitted filter. Required Permissions: Read-Only Sales Person, Read-Write Sales Person\n\n- **Endpoint:** `GET /rest/v1/salespersons.json`\n- **Operation ID:** `getSalesPersonUsingGET`\n- **API:** Core API · Sales Persons\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get SalesPersons on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/sales-persons/get-salespersons/)\n\n### Parameters\n\n- `filterType` · query param · string · required\n- `filterValues` · query param · array of string · required\n- `fields` · query param · array of string · optional\n- `batchSize` · query param · integer (int32) · optional\n- `nextPageToken` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfSalesPerson](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofsalesperson/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n1. Send this request. If the response has `moreResult` set to `true`, copy the `nextPageToken` from the response into the `nextPageToken` param, and send the request again.\n2. Stop when `moreResult` is `false`.\n3. `batchSize` sets the maximum number of records per response.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "6753ada5-37d5-5536-913a-2d9dfbbab5bc", "name": "POST · Sync SalesPersons", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"input\": []\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/salespersons.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "salespersons.json" ] }, "description": "> **Changes data.** Sending this request creates or updates records in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nAllows inserts, updates, or upserts of salespersons to the target instance. Required Permissions: Read-Write Sales Person\n\n- **Endpoint:** `POST /rest/v1/salespersons.json`\n- **Operation ID:** `syncSalesPersonsUsingPOST`\n- **API:** Core API · Sales Persons\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Sync SalesPersons on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/sales-persons/sync-salespersons/)\n\n### Request body\n\n`application/json` · required · model [SyncSalesPersonRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/syncsalespersonrequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `action` · string · optional — Type of sync operation to perform. Allowed values: `createOnly`, `updateOnly`, `createOrUpdate`.\n- `dedupeBy` · string · optional — Field to deduplicate on. If the value in the field for a given record is not unique, an error will be returned for the individual record.\n- `input` · array of SalesPerson · required — List of input records.\n- `input[].id` · integer (int64) · optional — Unique integer id of the salesperson record.\n- `input[].reasons` · array of Reason · optional · returned in responses; do not send — List of reasons why an operation did not succeed. Reasons are only present in API responses and should not be submitted.\n- `input[].reasons[].code` · string · required — Integer code of the reason.\n- `input[].reasons[].message` · string · required — Message describing the reason for the status of the operation.\n- `input[].seq` · integer (int32) · optional · returned in responses; do not send — Integer indicating the sequence of the record in response. This value is correlated to the order of the records included in the request input. Seq should only be part of responses and should not be submitted.\n- `input[].status` · string · optional — Status of the operation performed on the record. Allowed values: `created`, `updated`, `deleted`, `skipped`, `added`, `removed`.\n\n### Responses\n\n- `200` — OK · [ResponseOfSalesPerson](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofsalesperson/)\n\nDeclared response media type: `application/json`." } }, { "id": "89283e03-c70d-523e-a273-212be4d3c2c7", "name": "POST · Delete SalesPersons", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"input\": []\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/salespersons/delete.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "salespersons", "delete.json" ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDeletes a list of salesperson records from the target instance. Input records should have only one member, based on the value of 'dedupeBy'. Required Permissions: Read-Write Sales Person\n\n- **Endpoint:** `POST /rest/v1/salespersons/delete.json`\n- **Operation ID:** `deleteSalesPersonUsingPOST`\n- **API:** Core API · Sales Persons\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete SalesPersons on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/sales-persons/delete-salespersons/)\n\n### Request body\n\n`application/json` · required · model [DeleteSalesPersonRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/deletesalespersonrequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `deleteBy` · string · optional — Key to use for deletion of the record.\n- `input` · array of SalesPerson · required — List of input records.\n- `input[].id` · integer (int64) · optional — Unique integer id of the salesperson record.\n- `input[].reasons` · array of Reason · optional · returned in responses; do not send — List of reasons why an operation did not succeed. Reasons are only present in API responses and should not be submitted.\n- `input[].reasons[].code` · string · required — Integer code of the reason.\n- `input[].reasons[].message` · string · required — Message describing the reason for the status of the operation.\n- `input[].seq` · integer (int32) · optional · returned in responses; do not send — Integer indicating the sequence of the record in response. This value is correlated to the order of the records included in the request input. Seq should only be part of responses and should not be submitted.\n- `input[].status` · string · optional — Status of the operation performed on the record. Allowed values: `created`, `updated`, `deleted`, `skipped`, `added`, `removed`.\n\n### Responses\n\n- `200` — OK · [ResponseOfSalesPerson](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofsalesperson/)\n\nDeclared response media type: `application/json`." } }, { "id": "943761e2-b0c7-502c-a632-364a1ff48d27", "name": "GET · Describe SalesPersons", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/salespersons/describe.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "salespersons", "describe.json" ] }, "description": "Returns metadata about salespersons and the fields available for interaction via the API. Required Permissions: Read-Only Sales Person, Read-Write Sales Person\n\n- **Endpoint:** `GET /rest/v1/salespersons/describe.json`\n- **Operation ID:** `describeUsingGET_5`\n- **API:** Core API · Sales Persons\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Describe SalesPersons on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/sales-persons/describe-salespersons/)\n\n### Responses\n\n- `200` — OK · [ResponseOfObjectMetaData](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofobjectmetadata/)\n\nDeclared response media type: `application/json`." } } ] }, { "id": "aa9e0e87-2174-502d-b206-bbf278fd75e1", "name": "Static Lists", "description": "Static Lists operations in the Core API. Reference: [Static Lists](https://mkto-ref.harrisonjennings.au/reference/core/static-lists/).", "item": [ { "id": "33243fa0-5322-5a6e-978b-bd457e7bdd8a", "name": "GET · Get Leads By List Id (/rest/v1/list/{listId}/leads.json)", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/list/:listId/leads.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "list", ":listId", "leads.json" ], "query": [ { "key": "fields", "value": "", "description": "Comma-separated list of lead fields to return for each record. If unset will return email, updatedAt, createdAt, lastName, firstName and id. Optional, array of string. Comma-separated list in a single value, e.g. a,b,c.", "disabled": true }, { "key": "batchSize", "value": "", "description": "The batch size to return. The max and default value is 300. Optional, integer (int32).", "disabled": true }, { "key": "nextPageToken", "value": "", "description": "A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info. Optional, string.", "disabled": true } ], "variable": [ { "key": "listId", "value": "", "description": "Id of the static list to retrieve records from. Required, integer (int32)." } ] }, "description": "Retrieves person records which are members of the given static list. Required Permissions: Read-Only Lead, Read-Write Lead\n\n- **Endpoint:** `GET /rest/v1/list/{listId}/leads.json`\n- **Operation ID:** `getLeadsByListIdUsingGET`\n- **API:** Core API · Static Lists\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Leads By List Id on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/static-lists/get-leads-by-list-id/)\n\n### Parameters\n\n- `listId` · path variable · integer (int32) · required\n- `fields` · query param · array of string · optional\n- `batchSize` · query param · integer (int32) · optional\n- `nextPageToken` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLeadByListId](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofleadbylistid/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n1. Send this request. To get the next page, copy the `nextPageToken` from the response into the `nextPageToken` param, and send the request again.\n2. `batchSize` sets the maximum number of records per response.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "1c36be0a-7060-5c13-8a79-eec31e171a8c", "name": "GET · Get Lists", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/lists.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "lists.json" ], "query": [ { "key": "id", "value": "", "description": "Comma-separated list of static list ids to return. Optional, array of integer (int32). Comma-separated list in a single value, e.g. a,b,c.", "disabled": true }, { "key": "name", "value": "", "description": "Comma-separated list of static list names to return. Optional, array of string. Comma-separated list in a single value, e.g. a,b,c.", "disabled": true }, { "key": "programName", "value": "", "description": "Comma-separated list of program names. If set will return all static lists that are children of the given programs. Optional, array of string. Comma-separated list in a single value, e.g. a,b,c.", "disabled": true }, { "key": "workspaceName", "value": "", "description": "Comma-separated list of workspace names. If set will return all static lists that are children of the given workspaces. Optional, array of string. Comma-separated list in a single value, e.g. a,b,c.", "disabled": true }, { "key": "batchSize", "value": "", "description": "The batch size to return. The max and default value is 300. Optional, integer (int32).", "disabled": true }, { "key": "nextPageToken", "value": "", "description": "A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info. Optional, string.", "disabled": true } ] }, "description": "Returns a set of static list records based on given filter parameters. Required Permissions: Read-Only Lead, Read-Write Lead\n\n- **Endpoint:** `GET /rest/v1/lists.json`\n- **Operation ID:** `getListsUsingGET`\n- **API:** Core API · Static Lists\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Lists on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/static-lists/get-lists/)\n\n### Parameters\n\n- `id` · query param · array of integer (int32) · optional\n- `name` · query param · array of string · optional\n- `programName` · query param · array of string · optional\n- `workspaceName` · query param · array of string · optional\n- `batchSize` · query param · integer (int32) · optional\n- `nextPageToken` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfStaticList](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofstaticlist/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n1. Send this request. To get the next page, copy the `nextPageToken` from the response into the `nextPageToken` param, and send the request again.\n2. `batchSize` sets the maximum number of records per response.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "5bc6ca06-782b-5d88-b0b1-c4bcb70ca7eb", "name": "GET · Get List by Id", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/lists/:listId.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "lists", ":listId.json" ], "variable": [ { "key": "listId", "value": "", "description": "Id of the static list to retrieve records from. Required, integer (int32)." } ] }, "description": "Returns a list record by its id. Required Permissions: Read-Only Lead, Read-Write Lead\n\n- **Endpoint:** `GET /rest/v1/lists/{listId}.json`\n- **Operation ID:** `getListByIdUsingGET`\n- **API:** Core API · Static Lists\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get List by Id on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/static-lists/get-list-by-id/)\n\n### Parameters\n\n- `listId` · path variable · integer (int32) · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfStaticList](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofstaticlist/)\n\nDeclared response media type: `application/json`." } }, { "id": "8ce7dafd-dace-562e-9dc2-32131ae293fb", "name": "GET · Get Leads By List Id (/rest/v1/lists/{listId}/leads.json)", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/lists/:listId/leads.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "lists", ":listId", "leads.json" ], "query": [ { "key": "fields", "value": "", "description": "Comma-separated list of lead fields to return for each record. If unset will return email, updatedAt, createdAt, lastName, firstName and id. Optional, array of string. Comma-separated list in a single value, e.g. a,b,c.", "disabled": true }, { "key": "batchSize", "value": "", "description": "The batch size to return. The max and default value is 300. Optional, integer (int32).", "disabled": true }, { "key": "nextPageToken", "value": "", "description": "A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info. Optional, string.", "disabled": true } ], "variable": [ { "key": "listId", "value": "", "description": "Id of the static list to retrieve records from. Required, integer (int32)." } ] }, "description": "Retrieves person records which are members of the given static list. Required Permissions: Read-Only Lead, Read-Write Lead\n\n- **Endpoint:** `GET /rest/v1/lists/{listId}/leads.json`\n- **Operation ID:** `getLeadsByListIdUsingGET_1`\n- **API:** Core API · Static Lists\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Leads By List Id on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/static-lists/get-leads-by-list-id-2/)\n\n### Parameters\n\n- `listId` · path variable · integer (int32) · required\n- `fields` · query param · array of string · optional\n- `batchSize` · query param · integer (int32) · optional\n- `nextPageToken` · query param · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfLead](https://mkto-ref.harrisonjennings.au/reference/core/models/responseoflead/)\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n1. Send this request. If the response has `moreResult` set to `true`, copy the `nextPageToken` from the response into the `nextPageToken` param, and send the request again.\n2. Stop when `moreResult` is `false`.\n3. `batchSize` sets the maximum number of records per response.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "9bd6fd29-6d00-5d8d-94f3-8641bd5389f0", "name": "POST · Add to List", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"id\": null\n }\n ]\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/lists/:listId/leads.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "lists", ":listId", "leads.json" ], "query": [ { "key": "id", "value": "", "description": "Comma-separated list of lead ids to add to the list. Required unless you send a request body, array of integer (int32). Comma-separated list in a single value, e.g. a,b,c.", "disabled": true } ], "variable": [ { "key": "listId", "value": "", "description": "Id of target list. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request adds records or associations in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nAdds a given set of person records to a target static list. There is a limit of 300 lead ids per request. Required Permissions: Read-Write Lead\n\n- **Endpoint:** `POST /rest/v1/lists/{listId}/leads.json`\n- **Operation ID:** `addLeadsToListUsingPOST`\n- **API:** Core API · Static Lists\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Add to List on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/static-lists/add-to-list/)\n\n### Parameters\n\n- `listId` · path variable · integer (int32) · required\n- `id` · query param · array of integer (int32) · required unless you send a request body\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · optional · model [ListOperationRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/listoperationrequest/)\n\nOptional JSON request body for submitting leads\n\nSend either `id` values in the query string or a request body.\n\nThe body starts with the required properties only, set to `null`. Replace each `null` with a value, and add any optional properties you need.\n\n**Properties**\n\n- `input` · array of LeadInputData · required — List of leads for input.\n- `input[].id` · integer (int64) · required — Unique integer id of a lead record.\n\n### Responses\n\n- `200` — OK · [ResponseOfListOperationOutputData](https://mkto-ref.harrisonjennings.au/reference/core/models/responseoflistoperationoutputdata/)\n\nDeclared response media type: `application/json`." } }, { "id": "aad585de-ad90-50a7-9414-32e2405012a8", "name": "DELETE · Remove from List", "request": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"id\": null\n }\n ]\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/lists/:listId/leads.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "lists", ":listId", "leads.json" ], "query": [ { "key": "id", "value": "", "description": "id. Required unless you send a request body, array of integer (int32). Comma-separated list in a single value, e.g. a,b,c.", "disabled": true } ], "variable": [ { "key": "listId", "value": "", "description": "Id of static list to remove leads from. Required, integer (int32)." } ] }, "description": "> **Changes data.** Sending this request removes records or associations in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nRemoves a given set of person records from a target static list. Required Permissions: Read-Write Lead\n\n- **Endpoint:** `DELETE /rest/v1/lists/{listId}/leads.json`\n- **Operation ID:** `removeLeadsFromListUsingDELETE`\n- **API:** Core API · Static Lists\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Remove from List on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/static-lists/remove-from-list/)\n\n### Parameters\n\n- `listId` · path variable · integer (int32) · required\n- `id` · query param · array of integer (int32) · required unless you send a request body\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · optional · model [ListOperationRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/listoperationrequest/)\n\nSend either `id` values in the query string or a request body.\n\nThe body starts with the required properties only, set to `null`. Replace each `null` with a value, and add any optional properties you need.\n\n**Properties**\n\n- `input` · array of LeadInputData · required — List of leads for input.\n- `input[].id` · integer (int64) · required — Unique integer id of a lead record.\n\n### Responses\n\n- `200` — OK · [ResponseOfListOperationOutputData](https://mkto-ref.harrisonjennings.au/reference/core/models/responseoflistoperationoutputdata/)\n\nDeclared response media type: `application/json`." } }, { "id": "4ef9cc69-ead4-50b1-9b0f-23f9b1225f18", "name": "GET · Member of List", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/rest/v1/lists/:listId/leads/ismember.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "lists", ":listId", "leads", "ismember.json" ], "query": [ { "key": "id", "value": "", "description": "Comma-separated list of lead ids to check. Required unless you send a request body, array of integer (int32). Comma-separated list in a single value, e.g. a,b,c.", "disabled": true } ], "variable": [ { "key": "listId", "value": "", "description": "Id of the static list to check against. Required, integer (int32)." } ] }, "description": "Checks if leads are members of a given static list. Required Permissions: Read-Write Lead\n\n- **Endpoint:** `GET /rest/v1/lists/{listId}/leads/ismember.json`\n- **Operation ID:** `areLeadsMemberOfListUsingGET`\n- **API:** Core API · Static Lists\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Member of List on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/static-lists/member-of-list/)\n\n### Parameters\n\n- `listId` · path variable · integer (int32) · required\n- `id` · query param · array of integer (int32) · required unless you send a request body\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · optional · model [ListOperationRequest](https://mkto-ref.harrisonjennings.au/reference/core/models/listoperationrequest/)\n\nOptional JSON request body\n\nSend either `id` values in the query string or a request body.\n\nThis body is optional and starts empty, so the request is sent without one. If you add a body, Postman sends it with this GET request (body pruning is disabled for it).\n\n**Properties**\n\n- `input` · array of LeadInputData · required — List of leads for input.\n- `input[].id` · integer (int64) · required — Unique integer id of a lead record.\n\n### Responses\n\n- `200` — OK · [ResponseOfListOperationOutputData](https://mkto-ref.harrisonjennings.au/reference/core/models/responseoflistoperationoutputdata/)\n\nDeclared response media type: `application/json`." } } ] }, { "id": "9be4b761-6835-52cd-ac7a-4acd2a5df56a", "name": "Usage", "description": "Usage operations in the Core API. Reference: [Usage](https://mkto-ref.harrisonjennings.au/reference/core/usage/).", "item": [ { "id": "4aff8650-ee38-50b4-aa3e-2df17c5069a8", "name": "GET · Get Daily Errors", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/stats/errors.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "stats", "errors.json" ] }, "description": "Retrieves a count of each error type they have encountered in the current day. Required Permissions: None\n\n- **Endpoint:** `GET /rest/v1/stats/errors.json`\n- **Operation ID:** `getDailyErrorsUsingGET`\n- **API:** Core API · Usage\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Daily Errors on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/usage/get-daily-errors/)\n\n### Responses\n\n- `200` — OK · [ResponseOfErrorsData](https://mkto-ref.harrisonjennings.au/reference/core/models/responseoferrorsdata/)\n\nDeclared response media type: `application/json`." } }, { "id": "36e08595-0114-5579-af90-1b0384b4da70", "name": "GET · Get Weekly Errors", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/stats/errors/last7days.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "stats", "errors", "last7days.json" ] }, "description": "Returns a count of each error type they have encountered in the past 7 days. Required Permissions: None\n\n- **Endpoint:** `GET /rest/v1/stats/errors/last7days.json`\n- **Operation ID:** `getLast7DaysErrorsUsingGET`\n- **API:** Core API · Usage\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Weekly Errors on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/usage/get-weekly-errors/)\n\n### Responses\n\n- `200` — OK · [ResponseOfErrorsData](https://mkto-ref.harrisonjennings.au/reference/core/models/responseoferrorsdata/)\n\nDeclared response media type: `application/json`." } }, { "id": "15108096-88ae-5ed3-884b-b06191b9e974", "name": "GET · Get Daily Usage", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/stats/usage.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "stats", "usage.json" ] }, "description": "Returns the number of calls consumed for the day. Required Permissions: None\n\n- **Endpoint:** `GET /rest/v1/stats/usage.json`\n- **Operation ID:** `getDailyUsageUsingGET`\n- **API:** Core API · Usage\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Daily Usage on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/usage/get-daily-usage/)\n\n### Responses\n\n- `200` — OK · [ResponseOfUsageData](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofusagedata/)\n\nDeclared response media type: `application/json`." } }, { "id": "a42e2d86-da0d-5ae6-9325-35f1be30940c", "name": "GET · Get Weekly Usage", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/rest/v1/stats/usage/last7days.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "rest", "v1", "stats", "usage", "last7days.json" ] }, "description": "Returns the number of calls consumed in the past 7 days. Required Permissions: None\n\n- **Endpoint:** `GET /rest/v1/stats/usage/last7days.json`\n- **Operation ID:** `getLast7DaysUsageUsingGET`\n- **API:** Core API · Usage\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Weekly Usage on the documentation site](https://mkto-ref.harrisonjennings.au/reference/core/usage/get-weekly-usage/)\n\n### Responses\n\n- `200` — OK · [ResponseOfUsageData](https://mkto-ref.harrisonjennings.au/reference/core/models/responseofusagedata/)\n\nDeclared response media type: `application/json`." } } ] } ] }, { "id": "9fb853fa-5382-5c54-b6e1-279d65dfdab8", "name": "User Management API", "description": "Users, invitations, roles and workspaces.\n\n- **Base URL:** `{{marketoBaseUrl}}`\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [User Management API on the documentation site](https://mkto-ref.harrisonjennings.au/reference/user-management/)\n\nRequests run only when you send them, or when you select them for a Postman run.", "item": [ { "id": "16c41112-378e-5212-b135-b8ca724467cf", "name": "User Management", "description": "User Management operations in the User Management API. Reference: [User Management](https://mkto-ref.harrisonjennings.au/reference/user-management/user-management/).", "item": [ { "id": "c7eb2240-8305-538c-ad5a-7a87f700ba40", "name": "GET · Get Users", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/userservice/management/v1/users/allusers.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "userservice", "management", "v1", "users", "allusers.json" ], "query": [ { "key": "pageOffset", "value": "0", "description": "Integer offset for paging. Default is 0. Optional, integer (int32). Default: `0`.", "disabled": true }, { "key": "pageSize", "value": "20", "description": "Maximum number of users to return. Max 200, default 20. Optional, integer (int32). Default: `20`.", "disabled": true }, { "key": "includeRoleWorkspace", "value": "false", "description": "When true, adds the userRoleWorkspaces field to the results for each user. Requires the Access Roles permission. Default is false. Optional, boolean. Default: `false`.", "disabled": true } ] }, "description": "Retrieve a list of all user records. Required Permissions: Access User Management Api and Access Users\n\n- **Endpoint:** `GET /userservice/management/v1/users/allusers.json`\n- **Operation ID:** `getUsersUsingGET`\n- **API:** User Management API · User Management\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Users on the documentation site](https://mkto-ref.harrisonjennings.au/reference/user-management/user-management/get-users/)\n\n### Parameters\n\n- `pageOffset` · query param · integer (int32) · optional · Default: `0`\n- `pageSize` · query param · integer (int32) · optional · Default: `20`\n- `includeRoleWorkspace` · query param · boolean · optional · Default: `false`\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfAllUsers](https://mkto-ref.harrisonjennings.au/reference/user-management/models/responseofallusers/)\n- `401` — Unauthorized\n- `403` — Forbidden\n- `404` — Not Found\n\nDeclared response media type: `application/json`.\n\n### Pagination\n\n- `pageOffset`: Integer offset for paging. Default is 0.\n- `pageSize`: Maximum number of users to return. Max 200, default 20.\n\nAdobe's [User Management API documentation](https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/user-management) describes `pageOffset` as where to begin retrieving entries, not a page number. To get the next page, add the `pageSize` value you used to `pageOffset` and send the request again.\n\nContinue until a response returns no more records. The source specification does not say that a page with fewer than `pageSize` records is the last one.\n\nEach page is a separate request that you send yourself. The collection does not capture tokens or fetch pages automatically; you can paste values, or use Postman's **Set as variable** on a response value." } }, { "id": "c7da9e26-0d96-5400-a0ff-23b8b9c33622", "name": "POST · Invite User", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"emailAddress\": null,\n \"firstName\": null,\n \"lastName\": null,\n \"userRoleWorkspaces\": [\n {\n \"accessRoleId\": null,\n \"workspaceId\": null\n }\n ]\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/userservice/management/v1/users/invite.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "userservice", "management", "v1", "users", "invite.json" ] }, "description": "> **Changes data.** Sending this request sends a user invitation from the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nSend an email invitation to new user. Required Permissions: Access User Management Api and Access Users\n\n- **Endpoint:** `POST /userservice/management/v1/users/invite.json`\n- **Operation ID:** `inviteUserUsingPOST`\n- **API:** User Management API · User Management\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Invite User on the documentation site](https://mkto-ref.harrisonjennings.au/reference/user-management/user-management/invite-user/)\n\n### Request body\n\n`application/json` · required · model [InviteUserRequest](https://mkto-ref.harrisonjennings.au/reference/user-management/models/inviteuserrequest/)\n\nThe body starts with the required properties only, set to `null`. Replace each `null` with a value, and add any optional properties you need.\n\n**Properties**\n\n- `apiOnly` · boolean · optional — Whether the user is API-Only. Default is false.\n- `emailAddress` · string · required — User email address. Minimum length: `1`. Maximum length: `2147483647`. Pattern: `` ^(\"?)(?:[^\"])(?:[-\\w.!#$%&\\'*+\\/=?^_`{|}~])*\\1@(\\w[-\\w]{0,62}\\.)+[A-Za-z]{2,63}$ ``.\n- `expiresAt` · string · optional — Date and time when user login expires. Must be valid ISO-8601 string. See [Datetime](http://developers.marketo.com/rest-api/lead-database/fields/field-types/) field type description.\n- `firstName` · string · required — User first name.\n- `lastName` · string · required — User last name.\n- `userid` · string · optional — Marketo Identity users should use an email address. Adobe Identity users should use the generated GUID.\n- `reason` · string · optional — Reason for user invitation.\n- `userRoleWorkspaces` · array of UserRoleWorkspaceId · required — Not documented in the source specification.\n- `userRoleWorkspaces[].accessRoleId` · integer (int32) · required — User role id.\n- `userRoleWorkspaces[].workspaceId` · integer (int32) · required — User workspace id.\n\n### Responses\n\n- `200` — OK\n- `201` — Created\n- `401` — Unauthorized\n- `403` — Forbidden\n- `404` — Not Found\n\nDeclared response media type: `application/json`." } }, { "id": "3b281ebe-3b6e-5913-9965-d9c58460d52b", "name": "GET · Get Roles", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/userservice/management/v1/users/roles.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "userservice", "management", "v1", "users", "roles.json" ] }, "description": "Retrieve list of all role records. Required Permissions: Access User Management Api and Access Users\n\n- **Endpoint:** `GET /userservice/management/v1/users/roles.json`\n- **Operation ID:** `getRolesUsingGET`\n- **API:** User Management API · User Management\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Roles on the documentation site](https://mkto-ref.harrisonjennings.au/reference/user-management/user-management/get-roles/)\n\n### Responses\n\n- `200` — OK · [ResponseOfRole](https://mkto-ref.harrisonjennings.au/reference/user-management/models/responseofrole/)\n- `401` — Unauthorized\n- `403` — Forbidden\n- `404` — Not Found\n\nDeclared response media type: `application/json`." } }, { "id": "20ef19c5-12e6-5569-b4b9-75c7b78ff00a", "name": "GET · Get Workspaces", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/userservice/management/v1/users/workspaces.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "userservice", "management", "v1", "users", "workspaces.json" ] }, "description": "Retrieve list of workspace records. Required Permissions: Access User Management Api and Access Users\n\n- **Endpoint:** `GET /userservice/management/v1/users/workspaces.json`\n- **Operation ID:** `getWorkspacesUsingGET`\n- **API:** User Management API · User Management\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Workspaces on the documentation site](https://mkto-ref.harrisonjennings.au/reference/user-management/user-management/get-workspaces/)\n\n### Responses\n\n- `200` — OK · [ResponseOfWorkspace](https://mkto-ref.harrisonjennings.au/reference/user-management/models/responseofworkspace/)\n- `401` — Unauthorized\n- `403` — Forbidden\n- `404` — Not Found\n\nDeclared response media type: `application/json`." } }, { "id": "8dd03aa0-b085-59c0-9c4f-abba9716d3d2", "name": "POST · Delete User", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/userservice/management/v1/users/:userid/delete.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "userservice", "management", "v1", "users", ":userid", "delete.json" ], "variable": [ { "key": "userid", "value": "", "description": "User id in the form of an email address. Required, string." } ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDelete user. Required Permissions: Access User Management Api and Access Users\n\n- **Endpoint:** `POST /userservice/management/v1/users/{userid}/delete.json`\n- **Operation ID:** `deleteUserUsingPOST`\n- **API:** User Management API · User Management\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete User on the documentation site](https://mkto-ref.harrisonjennings.au/reference/user-management/user-management/delete-user/)\n\n### Parameters\n\n- `userid` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK\n- `401` — Unauthorized\n- `403` — Forbidden\n- `404` — Not Found\n\nDeclared response media type: `application/json`." } }, { "id": "57473b51-310f-5707-a54b-58b0633da6a1", "name": "POST · Delete Invited User", "request": { "method": "POST", "header": [], "url": { "raw": "{{marketoBaseUrl}}/userservice/management/v1/users/:userid/invite/delete.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "userservice", "management", "v1", "users", ":userid", "invite", "delete.json" ], "variable": [ { "key": "userid", "value": "", "description": "User id in the form of an email address. Required, string." } ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDelete pending user. A pending user is a user that has not yet accepted invitation. Required Permissions: Access User Management Api and Access Users\n\n- **Endpoint:** `POST /userservice/management/v1/users/{userid}/invite/delete.json`\n- **Operation ID:** `deleteInvitedUserUsingPOST`\n- **API:** User Management API · User Management\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete Invited User on the documentation site](https://mkto-ref.harrisonjennings.au/reference/user-management/user-management/delete-invited-user/)\n\n### Parameters\n\n- `userid` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK\n- `401` — Unauthorized\n- `403` — Forbidden\n- `404` — Not Found\n\nDeclared response media type: `application/json`." } }, { "id": "7203fd90-28da-5d5e-9f1b-88583d41c66d", "name": "POST · Update User Attributes", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/userservice/management/v1/users/:userid/update.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "userservice", "management", "v1", "users", ":userid", "update.json" ], "variable": [ { "key": "userid", "value": "", "description": "User id in the form of an email address. Required, string." } ] }, "description": "> **Changes data.** Sending this request changes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpdate one or more user attributes. Required Permissions: Access User Management Api and Access Users\n\n- **Endpoint:** `POST /userservice/management/v1/users/{userid}/update.json`\n- **Operation ID:** `updateUserAttributeUsingPOST`\n- **API:** User Management API · User Management\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Update User Attributes on the documentation site](https://mkto-ref.harrisonjennings.au/reference/user-management/user-management/update-user-attributes/)\n\n### Parameters\n\n- `userid` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [UpdateUserAttributesRequest](https://mkto-ref.harrisonjennings.au/reference/user-management/models/updateuserattributesrequest/)\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `apiOnly` · boolean · optional — Whether the user is API-Only. Default is false.\n- `emailAddress` · string · optional — User email address. Minimum length: `1`. Maximum length: `2147483647`. Pattern: `` ^(\"?)(?:[^\"])(?:[-\\w.!#$%&\\'*+\\/=?^_`{|}~])*\\1@(\\w[-\\w]{0,62}\\.)+[A-Za-z]{2,63}$ ``.\n- `expiresAt` · string · optional — Date and time when user login expires. Example: yyyy-MM-dd'T'HH:mm:ss.SSS't'Z. Example: `yyyyMMdd'T'HH:mm:ss'.'S't'Z`.\n- `firstName` · string · optional — User first name.\n- `lastName` · string · optional — User last name.\n\n### Responses\n\n- `200` — OK · [ResponseOfUser](https://mkto-ref.harrisonjennings.au/reference/user-management/models/responseofuser/)\n- `201` — Created\n- `401` — Unauthorized\n- `403` — Forbidden\n- `404` — Not Found\n\nDeclared response media type: `application/json`." } }, { "id": "d179d8ab-e38a-5712-901a-a80e01ae4339", "name": "GET · Get Roles and Workspaces by Id", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/userservice/management/v1/users/:userid/roles.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "userservice", "management", "v1", "users", ":userid", "roles.json" ], "variable": [ { "key": "userid", "value": "", "description": "User id in the form of an email address. Required, string." } ] }, "description": "Get roles and workspaces for a given user. Required Permissions: Access User Management Api and Access Users\n\n- **Endpoint:** `GET /userservice/management/v1/users/{userid}/roles.json`\n- **Operation ID:** `getUserRolesAndWorkspacesUsingGET`\n- **API:** User Management API · User Management\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Roles and Workspaces by Id on the documentation site](https://mkto-ref.harrisonjennings.au/reference/user-management/user-management/get-roles-and-workspaces-by-id/)\n\n### Parameters\n\n- `userid` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [UserRoleWorkspace](https://mkto-ref.harrisonjennings.au/reference/user-management/models/userroleworkspace/)\n- `401` — Unauthorized\n- `403` — Forbidden\n- `404` — Not Found\n\nDeclared response media type: `application/json`." } }, { "id": "c1d2d8f0-7cb9-5b84-81d1-af59f8f63964", "name": "POST · Add Roles", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"accessRoleId\": null,\n \"workspaceId\": null\n }\n ]\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/userservice/management/v1/users/:userid/roles/create.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "userservice", "management", "v1", "users", ":userid", "roles", "create.json" ], "variable": [ { "key": "userid", "value": "", "description": "User id in the form of an email address. Required, string." } ] }, "description": "> **Changes data.** Sending this request adds records or associations in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nAdd roles to a user. Required Permissions: Access User Management Api and Access Users\n\n- **Endpoint:** `POST /userservice/management/v1/users/{userid}/roles/create.json`\n- **Operation ID:** `addRolesUsingPOST`\n- **API:** User Management API · User Management\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Add Roles on the documentation site](https://mkto-ref.harrisonjennings.au/reference/user-management/user-management/add-roles/)\n\n### Parameters\n\n- `userid` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [AddRolesRequest](https://mkto-ref.harrisonjennings.au/reference/user-management/models/addrolesrequest/)\n\nThe body starts with the required properties only, set to `null`. Replace each `null` with a value, and add any optional properties you need.\n\n**Properties**\n\n- `input` · array of UserRoleWorkspaceId · required — List of roles to add.\n- `input[].accessRoleId` · integer (int32) · required — User role id.\n- `input[].workspaceId` · integer (int32) · required — User workspace id.\n\n### Responses\n\n- `200` — OK · [UserRoleWorkspace](https://mkto-ref.harrisonjennings.au/reference/user-management/models/userroleworkspace/)\n- `201` — Created\n- `401` — Unauthorized\n- `403` — Forbidden\n- `404` — Not Found\n\nDeclared response media type: `application/json`." } }, { "id": "a2b8185b-338e-533f-8e6d-1650cbe108d4", "name": "POST · Delete Roles", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"accessRoleId\": null,\n \"workspaceId\": null\n }\n ]\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{marketoBaseUrl}}/userservice/management/v1/users/:userid/roles/delete.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "userservice", "management", "v1", "users", ":userid", "roles", "delete.json" ], "variable": [ { "key": "userid", "value": "", "description": "User id in the form of an email address. Required, string." } ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nDelete roles from user. Required Permissions: Access User Management Api and Access Users\n\n- **Endpoint:** `POST /userservice/management/v1/users/{userid}/roles/delete.json`\n- **Operation ID:** `deleteRolesUsingPOST`\n- **API:** User Management API · User Management\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Delete Roles on the documentation site](https://mkto-ref.harrisonjennings.au/reference/user-management/user-management/delete-roles/)\n\n### Parameters\n\n- `userid` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [DeleteRolesRequest](https://mkto-ref.harrisonjennings.au/reference/user-management/models/deleterolesrequest/)\n\nThe body starts with the required properties only, set to `null`. Replace each `null` with a value, and add any optional properties you need.\n\n**Properties**\n\n- `input` · array of UserRoleWorkspaceId · required — List of roles to delete.\n- `input[].accessRoleId` · integer (int32) · required — User role id.\n- `input[].workspaceId` · integer (int32) · required — User workspace id.\n\n### Responses\n\n- `200` — OK · [UserRoleWorkspace](https://mkto-ref.harrisonjennings.au/reference/user-management/models/userroleworkspace/)\n- `401` — Unauthorized\n- `403` — Forbidden\n- `404` — Not Found\n\nDeclared response media type: `application/json`." } }, { "id": "39032d0a-c62c-5a4c-8224-d90bfd010afa", "name": "GET · Get User by Id", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/userservice/management/v1/users/:userid/user.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "userservice", "management", "v1", "users", ":userid", "user.json" ], "variable": [ { "key": "userid", "value": "", "description": "User id in the form of an email address. Required, string." } ] }, "description": "Retrieve a single user record through its Id. Required Permissions: Access User Management Api and Access Users\n\n- **Endpoint:** `GET /userservice/management/v1/users/{userid}/user.json`\n- **Operation ID:** `getUserUsingGET`\n- **API:** User Management API · User Management\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get User by Id on the documentation site](https://mkto-ref.harrisonjennings.au/reference/user-management/user-management/get-user-by-id/)\n\n### Parameters\n\n- `userid` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfUser](https://mkto-ref.harrisonjennings.au/reference/user-management/models/responseofuser/)\n- `401` — Unauthorized\n- `403` — Forbidden\n- `404` — Not Found\n\nDeclared response media type: `application/json`." } }, { "id": "3ba0d032-475e-5775-83a3-38f909c3f086", "name": "GET · Get Invited User by Id", "request": { "method": "GET", "header": [], "url": { "raw": "{{marketoBaseUrl}}/userservice/management/v1/users/:userid/invite.json", "host": [ "{{marketoBaseUrl}}" ], "path": [ "userservice", "management", "v1", "users", ":userid", "invite.json" ], "variable": [ { "key": "userid", "value": "", "description": "User id in the form of an email address. Required, string." } ] }, "description": "Retrieve a single pending user record through its Id. A pending user is a user that has not yet accepted invitation. Required Permissions: Access User Management Api and Access Users\n\n- **Endpoint:** `GET /userservice/management/v1/users/{userid}/invite.json`\n- **Operation ID:** `getInvitedUserUsingGET`\n- **API:** User Management API · User Management\n- **Authentication:** Bearer token from `{{accessToken}}`, inherited from the collection's **Authorization** tab.\n- **Reference:** [Get Invited User by Id on the documentation site](https://mkto-ref.harrisonjennings.au/reference/user-management/user-management/get-invited-user-by-id/)\n\n### Parameters\n\n- `userid` · path variable · string · required\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Responses\n\n- `200` — OK · [ResponseOfInvitedUser](https://mkto-ref.harrisonjennings.au/reference/user-management/models/responseofinviteduser/)\n- `401` — Unauthorized\n- `403` — Forbidden\n- `404` — Not Found\n\nDeclared response media type: `application/json`." } } ] } ] }, { "id": "540ca6f1-b53b-51b1-881e-6a3aecfa0c66", "name": "Data Ingestion API", "description": "High-volume, asynchronous ingestion of persons, companies, custom objects, list memberships and program members.\n\n- **Base URL:** `{{ingestionBaseUrl}}`\n- **Authentication:** `X-Mkto-User-Token` header from `{{accessToken}}`, set on this request's **Authorization** tab (API Key).\n- **Reference:** [Data Ingestion API on the documentation site](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/)\n\nRequests run only when you send them, or when you select them for a Postman run.", "item": [ { "id": "444159ed-99ef-521b-98ff-ebb6aaee27cb", "name": "Companies", "description": "Companies operations in the Data Ingestion API. Reference: [Companies](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/companies/).", "item": [ { "id": "a136d9e0-d006-5b25-885d-8a2c40203993", "name": "POST · Sync Companies", "request": { "method": "POST", "header": [ { "key": "X-Correlation-Id", "value": "", "type": "text", "description": "Arbitrary string (max 255 characters). Used to trace requests through the system via Marketo Observability Data Stream. Optional, string.", "disabled": true }, { "key": "X-Request-Source", "value": "", "type": "text", "description": "Arbitrary string (max 50 characters). Used to trace the source of requests. Optional, string.", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"input\": []\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ingestionBaseUrl}}/subscriptions/:munchkinId/companies", "host": [ "{{ingestionBaseUrl}}" ], "path": [ "subscriptions", ":munchkinId", "companies" ], "variable": [ { "key": "munchkinId", "value": "{{munchkinId}}", "description": "Marketo subscription Munchkin ID. Required, string. Set from the {{munchkinId}} environment variable." } ] }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Mkto-User-Token", "type": "string" }, { "key": "value", "value": "{{accessToken}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "description": "> **Changes data.** Sending this request creates or updates records in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nSync a list of company records. Supports create, update, and upsert operations with deduplication by external company ID or Marketo internal ID. Required permission: `Read-Write Company`.\n\n- **Endpoint:** `POST /subscriptions/{munchkinId}/companies`\n- **Operation ID:** `syncCompanies`\n- **API:** Data Ingestion API · Companies\n- **Authentication:** `X-Mkto-User-Token` header from `{{accessToken}}`, set on this request's **Authorization** tab (API Key).\n- **Reference:** [Sync Companies on the documentation site](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/companies/sync-companies/)\n\n### Parameters\n\n- `munchkinId` · path variable · string · required\n- `X-Mkto-User-Token` · header, set by the Authorization tab · string · required — Marketo API access token.\n- `X-Correlation-Id` · header · string · optional\n- `X-Request-Source` · header · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [SyncCompaniesRequest](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/models/synccompaniesrequest/)\n\nThe source specification includes a request example; it is shown on the [reference page](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/companies/sync-companies/) and not copied here, because it contains sample records.\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `action` · string · optional — Sync action. For createOnly and createOrUpdate, only dedupeFields is allowed for dedupeBy. For updateOnly, both dedupeFields and idField are allowed. Allowed values: `createOnly`, `updateOnly`, `createOrUpdate`. Default: `createOrUpdate`.\n- `dedupeBy` · string · optional — Field to deduplicate on (case-insensitive). Allowed values: `dedupeFields`, `idField`. Default: `dedupeFields`.\n- `input` · array of Company · required — List of company attribute name-value pairs.\n- `input[].id` · integer (int64) · optional — Marketo internal company ID. Required when dedupeBy is idField and action is updateOnly.\n- `input[].externalCompanyId` · string · optional — External company identifier. Required when dedupeBy is dedupeFields.\n- `input[].company` · string · optional — Company name.\n\n### Responses\n\n- `202` — Accepted – request accepted for async processing\n- `400` — Bad request – validation error (e.g. invalid dedupeBy, missing company id for updateOnly when dedupeBy is idField, empty input, invalid action) · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/models/errorresponse/)\n- `401` — Unauthorized – OAuth token is invalid · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/models/errorresponse/)\n\nDeclared response media type: `application/json`." } } ] }, { "id": "7680fc56-5066-5ce3-8be9-c56f7afc052a", "name": "Custom Objects", "description": "Custom Objects operations in the Data Ingestion API. Reference: [Custom Objects](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/custom-objects/).", "item": [ { "id": "55a792c6-275d-5583-8c22-744e767376dd", "name": "POST · Sync Custom Objects", "request": { "method": "POST", "header": [ { "key": "X-Correlation-Id", "value": "", "type": "text", "description": "Arbitrary string (max 255 characters). Used to trace requests through the system via Marketo Observability Data Stream. Optional, string.", "disabled": true }, { "key": "X-Request-Source", "value": "", "type": "text", "description": "Arbitrary string (max 50 characters). Used to trace the source of requests. Optional, string.", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"customObjects\": []\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ingestionBaseUrl}}/subscriptions/:munchkinId/customobjects/:customObjectAPIName", "host": [ "{{ingestionBaseUrl}}" ], "path": [ "subscriptions", ":munchkinId", "customobjects", ":customObjectAPIName" ], "variable": [ { "key": "munchkinId", "value": "{{munchkinId}}", "description": "Marketo subscription Munchkin ID. Required, string. Set from the {{munchkinId}} environment variable." }, { "key": "customObjectAPIName", "value": "", "description": "The API name of the custom object type. Required, string. Example: `purchases`." } ] }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Mkto-User-Token", "type": "string" }, { "key": "value", "value": "{{accessToken}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "description": "> **Changes data.** Sending this request creates or updates records in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpsert (insert or update) a list of custom object records. If a link field to a Person is specified in the request and that Person does not exist, several retries occur. If that Person is added during the retry window (65 minutes), then the update is successful. Required permission: `Read-Write Custom Object`.\n\n- **Endpoint:** `POST /subscriptions/{munchkinId}/customobjects/{customObjectAPIName}`\n- **Operation ID:** `syncCustomObjects`\n- **API:** Data Ingestion API · Custom Objects\n- **Authentication:** `X-Mkto-User-Token` header from `{{accessToken}}`, set on this request's **Authorization** tab (API Key).\n- **Reference:** [Sync Custom Objects on the documentation site](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/custom-objects/sync-custom-objects/)\n\n### Parameters\n\n- `munchkinId` · path variable · string · required\n- `customObjectAPIName` · path variable · string · required · Example: `purchases`\n- `X-Mkto-User-Token` · header, set by the Authorization tab · string · required — Marketo API access token.\n- `X-Correlation-Id` · header · string · optional\n- `X-Request-Source` · header · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [SyncCustomObjectsRequest](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/models/synccustomobjectsrequest/)\n\nThe source specification includes a request example; it is shown on the [reference page](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/custom-objects/sync-custom-objects/) and not copied here, because it contains sample records.\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `priority` · string · optional — Priority of the request. Allowed values: `normal`, `high`. Default: `normal`.\n- `dedupeBy` · string · optional — Attributes to deduplicate on. Allowed values: `dedupeFields`, `marketoGUID`. Default: `dedupeFields`.\n- `customObjects` · array of CustomObject · required — List of attribute name-value pairs for the object.\n\n### Responses\n\n- `202` — Accepted – request accepted for async processing\n- `400` — Bad request · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/models/errorresponse/)\n- `401` — Unauthorized – OAuth token is invalid · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/models/errorresponse/)\n\nDeclared response media type: `application/json`." } } ] }, { "id": "aa40bbd6-0837-52ca-8559-41c0164a6292", "name": "Lists", "description": "Lists operations in the Data Ingestion API. Reference: [Lists](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/lists/).", "item": [ { "id": "6e4b396f-0ffb-5227-8227-337ffce7b5a3", "name": "POST · Add Leads to List", "request": { "method": "POST", "header": [ { "key": "X-Correlation-Id", "value": "", "type": "text", "description": "Arbitrary string (max 255 characters). Used to trace requests through the system via Marketo Observability Data Stream. Optional, string.", "disabled": true }, { "key": "X-Request-Source", "value": "", "type": "text", "description": "Arbitrary string (max 50 characters). Used to trace the source of requests. Optional, string.", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"listId\": null,\n \"input\": [\n {\n \"leadId\": null\n }\n ]\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ingestionBaseUrl}}/subscriptions/:munchkinId/lists", "host": [ "{{ingestionBaseUrl}}" ], "path": [ "subscriptions", ":munchkinId", "lists" ], "variable": [ { "key": "munchkinId", "value": "{{munchkinId}}", "description": "Marketo subscription Munchkin ID. Required, string. Set from the {{munchkinId}} environment variable." } ] }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Mkto-User-Token", "type": "string" }, { "key": "value", "value": "{{accessToken}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "description": "> **Changes data.** Sending this request adds records or associations in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nAdd leads to a static list. Required permission: `Read-Write Lead`.\n\n- **Endpoint:** `POST /subscriptions/{munchkinId}/lists`\n- **Operation ID:** `addToList`\n- **API:** Data Ingestion API · Lists\n- **Authentication:** `X-Mkto-User-Token` header from `{{accessToken}}`, set on this request's **Authorization** tab (API Key).\n- **Reference:** [Add Leads to List on the documentation site](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/lists/add-leads-to-list/)\n\n### Parameters\n\n- `munchkinId` · path variable · string · required\n- `X-Mkto-User-Token` · header, set by the Authorization tab · string · required — Marketo API access token.\n- `X-Correlation-Id` · header · string · optional\n- `X-Request-Source` · header · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [ListOperationRequest](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/models/listoperationrequest/)\n\nThe source specification includes a request example; it is shown on the [reference page](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/lists/add-leads-to-list/) and not copied here, because it contains sample records.\n\nThe body starts with the required properties only, set to `null`. Replace each `null` with a value, and add any optional properties you need.\n\n**Properties**\n\n- `listId` · integer (int64) · required — The Marketo static list ID. Must be a positive integer. Example: `1064`.\n- `input` · array of Lead · required — List of lead references to add to or remove from the list.\n- `input[].leadId` · integer (int64) · required — The Marketo lead ID. Example: `10001`.\n\n### Responses\n\n- `202` — Accepted – request accepted for async processing\n- `400` — Bad request – validation error (e.g. leads not specified, number of leads exceeded max size, invalid listId) · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/models/errorresponse/)\n- `401` — Unauthorized – OAuth token is invalid · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/models/errorresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "a042192f-5775-50d4-82f0-fe35668b5ff2", "name": "POST · Remove Leads from List", "request": { "method": "POST", "header": [ { "key": "X-Correlation-Id", "value": "", "type": "text", "description": "Arbitrary string (max 255 characters). Used to trace requests through the system via Marketo Observability Data Stream. Optional, string.", "disabled": true }, { "key": "X-Request-Source", "value": "", "type": "text", "description": "Arbitrary string (max 50 characters). Used to trace the source of requests. Optional, string.", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"listId\": null,\n \"input\": [\n {\n \"leadId\": null\n }\n ]\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ingestionBaseUrl}}/subscriptions/:munchkinId/lists/remove", "host": [ "{{ingestionBaseUrl}}" ], "path": [ "subscriptions", ":munchkinId", "lists", "remove" ], "variable": [ { "key": "munchkinId", "value": "{{munchkinId}}", "description": "Marketo subscription Munchkin ID. Required, string. Set from the {{munchkinId}} environment variable." } ] }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Mkto-User-Token", "type": "string" }, { "key": "value", "value": "{{accessToken}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "description": "> **Changes data.** Sending this request removes records or associations in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nRemove leads from a static list. This endpoint uses POST rather than DELETE because the request requires a JSON body with structured data. Required permission: `Read-Write Lead`.\n\n- **Endpoint:** `POST /subscriptions/{munchkinId}/lists/remove`\n- **Operation ID:** `removeFromList`\n- **API:** Data Ingestion API · Lists\n- **Authentication:** `X-Mkto-User-Token` header from `{{accessToken}}`, set on this request's **Authorization** tab (API Key).\n- **Reference:** [Remove Leads from List on the documentation site](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/lists/remove-leads-from-list/)\n\n### Parameters\n\n- `munchkinId` · path variable · string · required\n- `X-Mkto-User-Token` · header, set by the Authorization tab · string · required — Marketo API access token.\n- `X-Correlation-Id` · header · string · optional\n- `X-Request-Source` · header · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [ListOperationRequest](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/models/listoperationrequest/)\n\nThe source specification includes a request example; it is shown on the [reference page](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/lists/remove-leads-from-list/) and not copied here, because it contains sample records.\n\nThe body starts with the required properties only, set to `null`. Replace each `null` with a value, and add any optional properties you need.\n\n**Properties**\n\n- `listId` · integer (int64) · required — The Marketo static list ID. Must be a positive integer. Example: `1064`.\n- `input` · array of Lead · required — List of lead references to add to or remove from the list.\n- `input[].leadId` · integer (int64) · required — The Marketo lead ID. Example: `10001`.\n\n### Responses\n\n- `202` — Accepted – request accepted for async processing\n- `400` — Bad request – validation error (e.g. leads not specified, number of leads exceeded max size, invalid listId) · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/models/errorresponse/)\n- `401` — Unauthorized – OAuth token is invalid · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/models/errorresponse/)\n\nDeclared response media type: `application/json`." } } ] }, { "id": "1d578a2c-7836-50e2-9285-7b15ab3ec3c0", "name": "Persons", "description": "Persons operations in the Data Ingestion API. Reference: [Persons](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/persons/).", "item": [ { "id": "91191cf5-7ce4-57b2-beb6-46a4036df950", "name": "POST · Sync Persons", "request": { "method": "POST", "header": [ { "key": "X-Correlation-Id", "value": "", "type": "text", "description": "Arbitrary string (max 255 characters). Used to trace requests through the system via Marketo Observability Data Stream. Optional, string.", "disabled": true }, { "key": "X-Request-Source", "value": "", "type": "text", "description": "Arbitrary string (max 50 characters). Used to trace the source of requests. Optional, string.", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"persons\": []\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ingestionBaseUrl}}/subscriptions/:munchkinId/persons", "host": [ "{{ingestionBaseUrl}}" ], "path": [ "subscriptions", ":munchkinId", "persons" ], "variable": [ { "key": "munchkinId", "value": "{{munchkinId}}", "description": "Marketo subscription Munchkin ID. Required, string. Set from the {{munchkinId}} environment variable." } ] }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Mkto-User-Token", "type": "string" }, { "key": "value", "value": "{{accessToken}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "description": "> **Changes data.** Sending this request creates or updates records in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nUpsert (insert or update) a list of person/lead records. Required permission: `Read-Write Lead`.\n\n- **Endpoint:** `POST /subscriptions/{munchkinId}/persons`\n- **Operation ID:** `syncPersons`\n- **API:** Data Ingestion API · Persons\n- **Authentication:** `X-Mkto-User-Token` header from `{{accessToken}}`, set on this request's **Authorization** tab (API Key).\n- **Reference:** [Sync Persons on the documentation site](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/persons/sync-persons/)\n\n### Parameters\n\n- `munchkinId` · path variable · string · required\n- `X-Mkto-User-Token` · header, set by the Authorization tab · string · required — Marketo API access token.\n- `X-Correlation-Id` · header · string · optional\n- `X-Request-Source` · header · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [SyncPersonsRequest](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/models/syncpersonsrequest/)\n\nThe source specification includes a request example; it is shown on the [reference page](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/persons/sync-persons/) and not copied here, because it contains sample records.\n\nThe body starts with the required structure only. Add the properties you need.\n\n**Properties**\n\n- `priority` · string · optional — Priority of the request. Allowed values: `normal`, `high`. Default: `normal`.\n- `partitionName` · string · optional — Name of person partition. Default: `Default`.\n- `dedupeFields` · DedupeFields · optional — Attributes to deduplicate on. One or two attribute names are allowed. Two attributes are used in an AND operation. Supported attributes: id, email, sfdcAccountId, sfdcContactId, sfdcLeadId, sfdcLeadOwnerId, custom attributes (string and integer type only).\n- `dedupeFields.field1` · string · optional — Not documented in the source specification. Example: `email`.\n- `dedupeFields.field2` · string · optional — Not documented in the source specification. Example: `firstName`.\n- `persons` · array of Person · required — List of attribute name-value pairs for the person.\n\n### Responses\n\n- `202` — Accepted – request accepted for async processing\n- `400` — Bad request · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/models/errorresponse/)\n- `401` — Unauthorized – OAuth token is invalid · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/models/errorresponse/)\n\nDeclared response media type: `application/json`." } } ] }, { "id": "1da12d08-8cb0-502a-9635-1cf65ee65e4f", "name": "Program Members", "description": "Program Members operations in the Data Ingestion API. Reference: [Program Members](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/program-members/).", "item": [ { "id": "46e25c58-557b-5c6f-b1f7-763024c881fe", "name": "POST · Sync Program Member Status", "request": { "method": "POST", "header": [ { "key": "X-Correlation-Id", "value": "", "type": "text", "description": "Arbitrary string (max 255 characters). Used to trace requests through the system via Marketo Observability Data Stream. Optional, string.", "disabled": true }, { "key": "X-Request-Source", "value": "", "type": "text", "description": "Arbitrary string (max 50 characters). Used to trace the source of requests. Optional, string.", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"programs\": [\n {\n \"programId\": null,\n \"status\": null,\n \"members\": [\n {\n \"leadId\": null\n }\n ]\n }\n ]\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ingestionBaseUrl}}/subscriptions/:munchkinId/programmembers", "host": [ "{{ingestionBaseUrl}}" ], "path": [ "subscriptions", ":munchkinId", "programmembers" ], "variable": [ { "key": "munchkinId", "value": "{{munchkinId}}", "description": "Marketo subscription Munchkin ID. Required, string. Set from the {{munchkinId}} environment variable." } ] }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Mkto-User-Token", "type": "string" }, { "key": "value", "value": "{{accessToken}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "description": "> **Changes data.** Sending this request creates or updates records in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nSync (upsert) program member status. Adds leads to programs or updates their program status. Required permission: `Read-Write Lead`.\n\n- **Endpoint:** `POST /subscriptions/{munchkinId}/programmembers`\n- **Operation ID:** `syncProgramMembers`\n- **API:** Data Ingestion API · Program Members\n- **Authentication:** `X-Mkto-User-Token` header from `{{accessToken}}`, set on this request's **Authorization** tab (API Key).\n- **Reference:** [Sync Program Member Status on the documentation site](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/program-members/sync-program-member-status/)\n\n### Parameters\n\n- `munchkinId` · path variable · string · required\n- `X-Mkto-User-Token` · header, set by the Authorization tab · string · required — Marketo API access token.\n- `X-Correlation-Id` · header · string · optional\n- `X-Request-Source` · header · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [SyncProgramMembersRequest](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/models/syncprogrammembersrequest/)\n\nThe source specification includes a request example; it is shown on the [reference page](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/program-members/sync-program-member-status/) and not copied here, because it contains sample records.\n\nThe body starts with the required properties only, set to `null`. Replace each `null` with a value, and add any optional properties you need.\n\n**Properties**\n\n- `programs` · array of ProgramOperation · required — List of program operations. Each specifies a program, a target status, and the leads to sync.\n- `programs[].programId` · integer (int64) · required — The Marketo program ID. Must be a positive integer. Example: `1001`.\n- `programs[].status` · string · required — The program member status to set (e.g. 'Member', 'Influenced'). Must not be 'Not in Program'; use the delete endpoint instead. Example: `Member`.\n- `programs[].members` · array of ProgramMember · required — List of lead references to add or update in the program.\n- `programs[].members[].leadId` · integer (int64) · required — The Marketo lead ID. Example: `10001`.\n\n### Responses\n\n- `202` — Accepted – request accepted for async processing\n- `400` — Bad request – validation error (e.g. status not specified, lead ids not specified, number of leads exceeded max size, status 'Not in Program' not allowed, invalid programId) · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/models/errorresponse/)\n- `401` — Unauthorized – OAuth token is invalid · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/models/errorresponse/)\n\nDeclared response media type: `application/json`." } }, { "id": "3fc0c585-6a8f-5e2a-a202-dff5c4018f37", "name": "POST · Delete Program Members", "request": { "method": "POST", "header": [ { "key": "X-Correlation-Id", "value": "", "type": "text", "description": "Arbitrary string (max 255 characters). Used to trace requests through the system via Marketo Observability Data Stream. Optional, string.", "disabled": true }, { "key": "X-Request-Source", "value": "", "type": "text", "description": "Arbitrary string (max 50 characters). Used to trace the source of requests. Optional, string.", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"programs\": [\n {\n \"programId\": null,\n \"members\": [\n {\n \"leadId\": null\n }\n ]\n }\n ]\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ingestionBaseUrl}}/subscriptions/:munchkinId/programmembers/delete", "host": [ "{{ingestionBaseUrl}}" ], "path": [ "subscriptions", ":munchkinId", "programmembers", "delete" ], "variable": [ { "key": "munchkinId", "value": "{{munchkinId}}", "description": "Marketo subscription Munchkin ID. Required, string. Set from the {{munchkinId}} environment variable." } ] }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Mkto-User-Token", "type": "string" }, { "key": "value", "value": "{{accessToken}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "description": "> **Changes data.** Sending this request deletes data in the Marketo instance it is sent to. Use credentials with the least privilege you need, and a sandbox instance when testing.\n\nRemove leads from programs. Sets the lead's membership status to 'Not in Program'. This endpoint uses POST rather than DELETE because the request requires a JSON body with structured data. Required permission: `Read-Write Lead`.\n\n- **Endpoint:** `POST /subscriptions/{munchkinId}/programmembers/delete`\n- **Operation ID:** `deleteProgramMembers`\n- **API:** Data Ingestion API · Program Members\n- **Authentication:** `X-Mkto-User-Token` header from `{{accessToken}}`, set on this request's **Authorization** tab (API Key).\n- **Reference:** [Delete Program Members on the documentation site](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/program-members/delete-program-members/)\n\n### Parameters\n\n- `munchkinId` · path variable · string · required\n- `X-Mkto-User-Token` · header, set by the Authorization tab · string · required — Marketo API access token.\n- `X-Correlation-Id` · header · string · optional\n- `X-Request-Source` · header · string · optional\n\nEach parameter's description is on its row in the **Params** and **Headers** tabs. Optional parameters are disabled until you enable them; required ones are enabled and must have a value.\n\n### Request body\n\n`application/json` · required · model [DeleteProgramMembersRequest](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/models/deleteprogrammembersrequest/)\n\nThe source specification includes a request example; it is shown on the [reference page](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/program-members/delete-program-members/) and not copied here, because it contains sample records.\n\nThe body starts with the required properties only, set to `null`. Replace each `null` with a value, and add any optional properties you need.\n\n**Properties**\n\n- `programs` · array of DeleteProgramOperation · required — List of program delete operations.\n- `programs[].programId` · integer (int64) · required — The Marketo program ID. Must be a positive integer. Example: `1001`.\n- `programs[].members` · array of ProgramMember · required — List of lead references to remove from the program.\n- `programs[].members[].leadId` · integer (int64) · required — The Marketo lead ID. Example: `10001`.\n\n### Responses\n\n- `202` — Accepted – request accepted for async processing\n- `400` — Bad request – validation error (e.g. lead ids not specified, number of leads exceeded max size, invalid programId) · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/models/errorresponse/)\n- `401` — Unauthorized – OAuth token is invalid · [ErrorResponse](https://mkto-ref.harrisonjennings.au/reference/data-ingestion/models/errorresponse/)\n\nDeclared response media type: `application/json`." } } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] } }