{ "item": [ { "name": "Identity", "item": [ { "name": "Identity", "description": "Exchange a LaunchPoint Client ID and Client Secret for an OAuth 2.0 bearer token. Tokens are valid for 3600 seconds and calls to this endpoint do not count against the daily API quota.", "item": [ { "id": "de47e12b-cb41-49f3-a249-904f8671cb5d", "name": "Identity", "request": { "name": "Identity", "description": { "content": "Retrieve an access token from Marketo Engage. Calls to this endpoint are not counted towards API call limit.", "type": "text/plain" }, "url": { "path": [ "identity", "oauth", "token" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Client ID from Admin > Integration > Launchpoint menu.", "type": "text/plain" }, "key": "client_id", "value": "{{client_id}}" }, { "disabled": false, "description": { "content": "(Required) Client Secret from Admin > Integration > Launchpoint menu.", "type": "text/plain" }, "key": "client_secret", "value": "{{client_secret}}" }, { "disabled": false, "description": { "content": "(Required) Grant type. (This can only be one of client_credentials)", "type": "text/plain" }, "key": "grant_type", "value": "client_credentials" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "noauth" } }, "response": [ { "id": "c718627d-0e41-4477-abfe-c01075e4ab85", "name": "OK", "originalRequest": { "url": { "path": [ "identity", "oauth", "token" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Client ID from Admin > Integration > Launchpoint menu.", "type": "text/plain" }, "key": "client_id", "value": "" }, { "disabled": false, "description": { "content": "(Required) Client Secret from Admin > Integration > Launchpoint menu.", "type": "text/plain" }, "key": "client_secret", "value": "" }, { "disabled": false, "description": { "content": "(Required) Grant type. (This can only be one of client_credentials)", "type": "text/plain" }, "key": "grant_type", "value": "client_credentials" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"access_token\": \"\",\n \"scope\": \"\",\n \"expires_in\": \"\",\n \"token_type\": \"bearer\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9f54add1-a244-4c0d-a98d-0e9b3fdc36ca", "name": "Identity", "request": { "name": "Identity", "description": { "content": "Retrieve an access token from Marketo. Calls to this endpoint are not counted towards API call limit.", "type": "text/plain" }, "url": { "path": [ "identity", "oauth", "token" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Client ID from Admin > Integration > Launchpoint menu.", "type": "text/plain" }, "key": "client_id", "value": "{{client_id}}" }, { "disabled": false, "description": { "content": "(Required) Client Secret from Admin > Integration > Launchpoint menu.", "type": "text/plain" }, "key": "client_secret", "value": "{{client_secret}}" }, { "disabled": false, "description": { "content": "(Required) Grant type. (This can only be one of client_credentials)", "type": "text/plain" }, "key": "grant_type", "value": "client_credentials" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "noauth" } }, "response": [ { "id": "8d4c7b75-ef43-429c-ac7b-2345d3b7a7ea", "name": "OK", "originalRequest": { "url": { "path": [ "identity", "oauth", "token" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Client ID from Admin > Integration > Launchpoint menu.", "type": "text/plain" }, "key": "client_id", "value": "" }, { "disabled": false, "description": { "content": "(Required) Client Secret from Admin > Integration > Launchpoint menu.", "type": "text/plain" }, "key": "client_secret", "value": "" }, { "disabled": false, "description": { "content": "(Required) Grant type. (This can only be one of client_credentials)", "type": "text/plain" }, "key": "grant_type", "value": "client_credentials" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"access_token\": \"\",\n \"scope\": \"\",\n \"expires_in\": \"\",\n \"token_type\": \"bearer\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "Lead Database & Marketing Activities", "item": [ { "name": "Leads", "description": "Query, create, update, delete, and merge person (lead) records; describe lead fields and manage lead partitions.", "item": [ { "id": "62171522-ab7c-4aab-ad08-09ac98f3caa4", "name": "Get Lead by Id", "request": { "name": "Get Lead by Id", "description": { "content": "Retrieves a single lead record through its Marketo id. Required Permissions: Read-Only Lead, Read-Write Lead", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "lead", "{{leadId}}.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Comma separated list of field names. If omitted, the following default fields will be returned: email, updatedAt, createdAt, lastName, firstName, and id.", "type": "text/plain" }, "key": "fields", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "47335eae-10d0-43e3-a0b9-4d931d3adaaf", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "lead", "{{leadId}}.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Comma separated list of field names. If omitted, the following default fields will be returned: email, updatedAt, createdAt, lastName, firstName, and id.", "type": "text/plain" }, "key": "fields", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"membership\": {\n \"membershipDate\": \"\",\n \"progressionStatus\": \"\",\n \"acquiredBy\": \"\",\n \"isExhausted\": \"\",\n \"nurtureCadence\": \"\",\n \"reachedSuccess\": \"\",\n \"stream\": \"\"\n },\n \"reason\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"status\": \"\"\n },\n {\n \"id\": \"\",\n \"membership\": {\n \"membershipDate\": \"\",\n \"progressionStatus\": \"\",\n \"acquiredBy\": \"\",\n \"isExhausted\": \"\",\n \"nurtureCadence\": \"\",\n \"reachedSuccess\": \"\",\n \"stream\": \"\"\n },\n \"reason\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"status\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a67eb0ff-f2bf-4d6c-b7c1-e44c6822ccd8", "name": "Get Leads by Filter Type", "request": { "name": "Get Leads by Filter Type", "description": { "content": "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", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "leads.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) 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 endpoint.", "type": "text/plain" }, "key": "filterType", "value": "" }, { "disabled": false, "description": { "content": "(Required) A comma-separated list of values to filter on in the specified fields.", "type": "text/plain" }, "key": "filterValues", "value": "" }, { "disabled": true, "description": { "content": "A comma-separated list of lead fields to return for each record", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "{{nextPageToken}}" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3b263e10-1380-41e8-8b33-9ab796b12fe8", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "leads.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) 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 endpoint.", "type": "text/plain" }, "key": "filterType", "value": "" }, { "disabled": false, "description": { "content": "(Required) A comma-separated list of values to filter on in the specified fields.", "type": "text/plain" }, "key": "filterValues", "value": "" }, { "disabled": true, "description": { "content": "A comma-separated list of lead fields to return for each record", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"membership\": {\n \"membershipDate\": \"\",\n \"progressionStatus\": \"\",\n \"acquiredBy\": \"\",\n \"isExhausted\": \"\",\n \"nurtureCadence\": \"\",\n \"reachedSuccess\": \"\",\n \"stream\": \"\"\n },\n \"reason\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"status\": \"\"\n },\n {\n \"id\": \"\",\n \"membership\": {\n \"membershipDate\": \"\",\n \"progressionStatus\": \"\",\n \"acquiredBy\": \"\",\n \"isExhausted\": \"\",\n \"nurtureCadence\": \"\",\n \"reachedSuccess\": \"\",\n \"stream\": \"\"\n },\n \"reason\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"status\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9a8d686f-3491-4dfe-b29d-2b9705527caf", "name": "Sync Leads", "request": { "name": "Sync Leads", "description": { "content": "Syncs a list of leads to the target instance. Required Permissions: Read-Write Lead", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "leads.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"id\": \"\",\n \"membership\": {\n \"membershipDate\": \"\",\n \"progressionStatus\": \"\",\n \"acquiredBy\": \"\",\n \"isExhausted\": \"\",\n \"nurtureCadence\": \"\",\n \"reachedSuccess\": \"\",\n \"stream\": \"\"\n },\n \"reason\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"status\": \"\"\n },\n {\n \"id\": \"\",\n \"membership\": {\n \"membershipDate\": \"\",\n \"progressionStatus\": \"\",\n \"acquiredBy\": \"\",\n \"isExhausted\": \"\",\n \"nurtureCadence\": \"\",\n \"reachedSuccess\": \"\",\n \"stream\": \"\"\n },\n \"reason\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"status\": \"\"\n }\n ],\n \"action\": \"createOnly\",\n \"asyncProcessing\": \"\",\n \"lookupField\": \"\",\n \"partitionName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "2f7e8337-008e-4836-8dd0-cb165cde8ef8", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "leads.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"id\": \"\",\n \"membership\": {\n \"membershipDate\": \"\",\n \"progressionStatus\": \"\",\n \"acquiredBy\": \"\",\n \"isExhausted\": \"\",\n \"nurtureCadence\": \"\",\n \"reachedSuccess\": \"\",\n \"stream\": \"\"\n },\n \"reason\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"status\": \"\"\n },\n {\n \"id\": \"\",\n \"membership\": {\n \"membershipDate\": \"\",\n \"progressionStatus\": \"\",\n \"acquiredBy\": \"\",\n \"isExhausted\": \"\",\n \"nurtureCadence\": \"\",\n \"reachedSuccess\": \"\",\n \"stream\": \"\"\n },\n \"reason\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"status\": \"\"\n }\n ],\n \"action\": \"createOnly\",\n \"asyncProcessing\": \"\",\n \"lookupField\": \"\",\n \"partitionName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"membership\": {\n \"membershipDate\": \"\",\n \"progressionStatus\": \"\",\n \"acquiredBy\": \"\",\n \"isExhausted\": \"\",\n \"nurtureCadence\": \"\",\n \"reachedSuccess\": \"\",\n \"stream\": \"\"\n },\n \"reason\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"status\": \"\"\n },\n {\n \"id\": \"\",\n \"membership\": {\n \"membershipDate\": \"\",\n \"progressionStatus\": \"\",\n \"acquiredBy\": \"\",\n \"isExhausted\": \"\",\n \"nurtureCadence\": \"\",\n \"reachedSuccess\": \"\",\n \"stream\": \"\"\n },\n \"reason\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"status\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3e354dcd-6ead-489c-962e-f358b319bf72", "name": "Delete Leads", "request": { "name": "Delete Leads", "description": { "content": "Delete a list of leads from the destination instance. Required Permissions: Read-Write Lead", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "leads", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Parameter can be specified if the request body is empty. Multiple lead ids can be specified. e.g. id=1,2,3,2342", "type": "text/plain" }, "key": "id", "value": "" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "df0fc55f-85a0-425d-9d08-2235cd9ebfad", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "leads", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Parameter can be specified if the request body is empty. Multiple lead ids can be specified. e.g. id=1,2,3,2342", "type": "text/plain" }, "key": "id", "value": "" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"membership\": {\n \"membershipDate\": \"\",\n \"progressionStatus\": \"\",\n \"acquiredBy\": \"\",\n \"isExhausted\": \"\",\n \"nurtureCadence\": \"\",\n \"reachedSuccess\": \"\",\n \"stream\": \"\"\n },\n \"reason\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"status\": \"\"\n },\n {\n \"id\": \"\",\n \"membership\": {\n \"membershipDate\": \"\",\n \"progressionStatus\": \"\",\n \"acquiredBy\": \"\",\n \"isExhausted\": \"\",\n \"nurtureCadence\": \"\",\n \"reachedSuccess\": \"\",\n \"stream\": \"\"\n },\n \"reason\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"status\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c531ac24-7bbc-4a09-89f5-095fab24a0a5", "name": "Describe Lead", "request": { "name": "Describe Lead", "description": { "content": "Returns 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

Note: This endpoint has been superseded. Use Describe Lead2 endpoint instead.", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "leads", "describe.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "bf07bfe9-9da3-4019-8552-2cb28115622f", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "leads", "describe.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"id\": \"\",\n \"length\": \"\",\n \"rest\": {\n \"name\": \"\",\n \"readOnly\": \"\"\n },\n \"soap\": {\n \"name\": \"\",\n \"readOnly\": \"\"\n }\n },\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"id\": \"\",\n \"length\": \"\",\n \"rest\": {\n \"name\": \"\",\n \"readOnly\": \"\"\n },\n \"soap\": {\n \"name\": \"\",\n \"readOnly\": \"\"\n }\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "938ba448-93a9-4d90-b1d8-7ae7ec9bd460", "name": "Describe Lead2", "request": { "name": "Describe Lead2", "description": { "content": "Returns list of searchable fields on lead objects in the target instance. Required Permissions: Read-Only Lead, Read-Write Lead", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "leads", "describe2.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e3a0af1d-23a4-4805-bbec-46a86b671329", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "leads", "describe2.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"name\": \"\",\n \"searchableFields\": [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ],\n \"fields\": [\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"dataType\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\",\n \"length\": \"\"\n },\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"dataType\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\",\n \"length\": \"\"\n }\n ]\n },\n {\n \"name\": \"\",\n \"searchableFields\": [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ],\n \"fields\": [\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"dataType\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\",\n \"length\": \"\"\n },\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"dataType\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\",\n \"length\": \"\"\n }\n ]\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "487ec5da-ebcf-4f98-ad11-c92e1f0a5eb4", "name": "Get Lead Partitions", "request": { "name": "Get Lead Partitions", "description": { "content": "Returns a list of available partitions in the target instance. Required Permissions: Read-Only Lead, Read-Write Lead", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "leads", "partitions.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "efa32e85-46cf-4f5a-9162-4e804bcd6502", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "leads", "partitions.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e2cf457a-9281-4d07-831e-eb0fffd66ea3", "name": "Update Lead Partition", "request": { "name": "Update Lead Partition", "description": { "content": "Updates the lead partition for a list of leads. Required Permissions: Read-Write Lead", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "leads", "partitions.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"id\": \"\",\n \"partitionName\": \"\"\n },\n {\n \"id\": \"\",\n \"partitionName\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d4418e46-4d99-4e03-9def-e279ed04c4c7", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "leads", "partitions.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"id\": \"\",\n \"partitionName\": \"\"\n },\n {\n \"id\": \"\",\n \"partitionName\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"membership\": {\n \"membershipDate\": \"\",\n \"progressionStatus\": \"\",\n \"acquiredBy\": \"\",\n \"isExhausted\": \"\",\n \"nurtureCadence\": \"\",\n \"reachedSuccess\": \"\",\n \"stream\": \"\"\n },\n \"reason\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"status\": \"\"\n },\n {\n \"id\": \"\",\n \"membership\": {\n \"membershipDate\": \"\",\n \"progressionStatus\": \"\",\n \"acquiredBy\": \"\",\n \"isExhausted\": \"\",\n \"nurtureCadence\": \"\",\n \"reachedSuccess\": \"\",\n \"stream\": \"\"\n },\n \"reason\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"status\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e1741ec6-810b-4feb-8ed4-1ecf93761825", "name": "Get Leads by Program Id", "request": { "name": "Get Leads by Program Id", "description": { "content": "Retrieves a list of leads which are members of the designated program. Required Permissions: Read-Only Lead, Read-Write Lead", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "leads", "programs", "{{programId}}.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "A comma-separated list of fields to be returned for each record", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "{{nextPageToken}}" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "00d05867-1656-49f6-a7e0-2445407651ab", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "leads", "programs", "{{programId}}.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "A comma-separated list of fields to be returned for each record", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"membership\": {\n \"membershipDate\": \"\",\n \"progressionStatus\": \"\",\n \"acquiredBy\": \"\",\n \"isExhausted\": \"\",\n \"nurtureCadence\": \"\",\n \"reachedSuccess\": \"\",\n \"stream\": \"\"\n },\n \"reason\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"status\": \"\"\n },\n {\n \"id\": \"\",\n \"membership\": {\n \"membershipDate\": \"\",\n \"progressionStatus\": \"\",\n \"acquiredBy\": \"\",\n \"isExhausted\": \"\",\n \"nurtureCadence\": \"\",\n \"reachedSuccess\": \"\",\n \"stream\": \"\"\n },\n \"reason\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"status\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "42c35a94-a9b9-4eb3-882d-182861be667f", "name": "Change Lead Program Status", "request": { "name": "Change Lead Program Status", "description": { "content": "Changes 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

Note: This endpoint has been superseded. Use Sync Program Member Status endpoint instead.", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "leads", "programs", ":programId", "status.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "programId", "disabled": false, "description": { "content": "(Required) The id of target program", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"status\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "168d5982-d0aa-4ac3-85be-bff8db16cddb", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "leads", "programs", ":programId", "status.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The id of target program", "type": "text/plain" }, "type": "any", "value": "", "key": "programId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"status\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"status\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"status\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cf8d4331-ec7e-44d3-9ce0-a2662e8b0c20", "name": "Push Lead to Marketo", "request": { "name": "Push Lead to Marketo", "description": { "content": "Upserts a lead and generates a Push Lead to Marketo activity. Required Permissions: Read-Write Lead", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "leads", "push.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"id\": \"\",\n \"reason\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"status\": \"\"\n },\n {\n \"id\": \"\",\n \"reason\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"status\": \"\"\n }\n ],\n \"lookupField\": \"\",\n \"partitionName\": \"\",\n \"programName\": \"\",\n \"programStatus\": \"\",\n \"reason\": \"\",\n \"source\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "08c93a79-ceb7-443e-9559-2a07ff4675fd", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "leads", "push.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"id\": \"\",\n \"reason\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"status\": \"\"\n },\n {\n \"id\": \"\",\n \"reason\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"status\": \"\"\n }\n ],\n \"lookupField\": \"\",\n \"partitionName\": \"\",\n \"programName\": \"\",\n \"programStatus\": \"\",\n \"reason\": \"\",\n \"source\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"membership\": {\n \"membershipDate\": \"\",\n \"progressionStatus\": \"\",\n \"acquiredBy\": \"\",\n \"isExhausted\": \"\",\n \"nurtureCadence\": \"\",\n \"reachedSuccess\": \"\",\n \"stream\": \"\"\n },\n \"reason\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"status\": \"\"\n },\n {\n \"id\": \"\",\n \"membership\": {\n \"membershipDate\": \"\",\n \"progressionStatus\": \"\",\n \"acquiredBy\": \"\",\n \"isExhausted\": \"\",\n \"nurtureCadence\": \"\",\n \"reachedSuccess\": \"\",\n \"stream\": \"\"\n },\n \"reason\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"status\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "186f9c9b-58fd-4679-9191-0919aa6b88a9", "name": "Get Lead Fields", "request": { "name": "Get Lead Fields", "description": { "content": "Retrieves metadata for all lead fields in the target instance. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "leads", "schema", "fields.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "{{nextPageToken}}" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2219218c-aff8-40e4-b03c-2fad938af087", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "leads", "schema", "fields.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"displayName\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"dataType\": \"\",\n \"isHidden\": \"\",\n \"isHtmlEncodingInEmail\": \"\",\n \"isSensitive\": \"\",\n \"isCustom\": \"\",\n \"isApiCreated\": \"\",\n \"length\": \"\"\n },\n {\n \"displayName\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"dataType\": \"\",\n \"isHidden\": \"\",\n \"isHtmlEncodingInEmail\": \"\",\n \"isSensitive\": \"\",\n \"isCustom\": \"\",\n \"isApiCreated\": \"\",\n \"length\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1fa70924-de6b-470a-b3c0-ae3156ed9ae5", "name": "Create Lead Fields", "request": { "name": "Create Lead Fields", "description": { "content": "Create lead fields in the target instance. Required Permissions: Read-Write Schema Custom Field", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "leads", "schema", "fields.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"displayName\": \"\",\n \"name\": \"\",\n \"dataType\": \"email\",\n \"description\": \"\",\n \"isHidden\": \"\",\n \"isHtmlEncodingInEmail\": \"\",\n \"isSensitive\": \"\"\n },\n {\n \"displayName\": \"\",\n \"name\": \"\",\n \"dataType\": \"integer\",\n \"description\": \"\",\n \"isHidden\": \"\",\n \"isHtmlEncodingInEmail\": \"\",\n \"isSensitive\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "df6615e2-413c-439a-91fa-108dfdd374e9", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "leads", "schema", "fields.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"displayName\": \"\",\n \"name\": \"\",\n \"dataType\": \"email\",\n \"description\": \"\",\n \"isHidden\": \"\",\n \"isHtmlEncodingInEmail\": \"\",\n \"isSensitive\": \"\"\n },\n {\n \"displayName\": \"\",\n \"name\": \"\",\n \"dataType\": \"integer\",\n \"description\": \"\",\n \"isHidden\": \"\",\n \"isHtmlEncodingInEmail\": \"\",\n \"isSensitive\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"name\": \"\",\n \"status\": \"created\"\n },\n {\n \"name\": \"\",\n \"status\": \"updated\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ddff3f6b-50d0-4085-b18f-852db43087d9", "name": "Get Lead Field by Name", "request": { "name": "Get Lead Field by Name", "description": { "content": "Retrieves metadata for single lead field. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "leads", "schema", "fields", "{{fieldApiName}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a288fecb-e01f-4831-a5ae-b6c47fcff53f", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "leads", "schema", "fields", "{{fieldApiName}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"displayName\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"dataType\": \"\",\n \"isHidden\": \"\",\n \"isHtmlEncodingInEmail\": \"\",\n \"isSensitive\": \"\",\n \"isCustom\": \"\",\n \"isApiCreated\": \"\",\n \"length\": \"\"\n },\n {\n \"displayName\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"dataType\": \"\",\n \"isHidden\": \"\",\n \"isHtmlEncodingInEmail\": \"\",\n \"isSensitive\": \"\",\n \"isCustom\": \"\",\n \"isApiCreated\": \"\",\n \"length\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "14a01ddf-b2c4-47b8-92bf-597f55fb6d0d", "name": "Update Lead Field", "request": { "name": "Update Lead Field", "description": { "content": "Update metadata for a lead field in the target instance. See update rules here. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "leads", "schema", "fields", "{{fieldApiName}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"displayName\": \"\",\n \"description\": \"\",\n \"isHidden\": \"\",\n \"isHtmlEncodingInEmail\": \"\",\n \"isSensitive\": \"\"\n },\n {\n \"displayName\": \"\",\n \"description\": \"\",\n \"isHidden\": \"\",\n \"isHtmlEncodingInEmail\": \"\",\n \"isSensitive\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "1bdc1248-6568-44e7-b0dc-93edbf66228b", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "leads", "schema", "fields", "{{fieldApiName}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"displayName\": \"\",\n \"description\": \"\",\n \"isHidden\": \"\",\n \"isHtmlEncodingInEmail\": \"\",\n \"isSensitive\": \"\"\n },\n {\n \"displayName\": \"\",\n \"description\": \"\",\n \"isHidden\": \"\",\n \"isHtmlEncodingInEmail\": \"\",\n \"isSensitive\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"name\": \"\",\n \"status\": \"created\"\n },\n {\n \"name\": \"\",\n \"status\": \"updated\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "32a3c218-391e-4ad6-8059-65bb7cd348b3", "name": "Submit Form", "request": { "name": "Submit Form", "description": { "content": "Upserts a lead and generates a \"Fill out Form\" activity which is associated back to program and/or campaign. Required Permissions: Read-Write Lead", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "leads", "submitForm.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"leadFormFields\": {\n \"email\": \"\"\n },\n \"visitorData\": {\n \"pageURL\": \"\",\n \"queryString\": \"\",\n \"leadClientIpAddress\": \"\",\n \"userAgentString\": \"\"\n },\n \"cookie\": \"\"\n },\n {\n \"leadFormFields\": {\n \"email\": \"\"\n },\n \"visitorData\": {\n \"pageURL\": \"\",\n \"queryString\": \"\",\n \"leadClientIpAddress\": \"\",\n \"userAgentString\": \"\"\n },\n \"cookie\": \"\"\n }\n ],\n \"formId\": \"\",\n \"programId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "fc06c2ef-b73e-46ed-8eb8-f83c2d807589", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "leads", "submitForm.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"leadFormFields\": {\n \"email\": \"\"\n },\n \"visitorData\": {\n \"pageURL\": \"\",\n \"queryString\": \"\",\n \"leadClientIpAddress\": \"\",\n \"userAgentString\": \"\"\n },\n \"cookie\": \"\"\n },\n {\n \"leadFormFields\": {\n \"email\": \"\"\n },\n \"visitorData\": {\n \"pageURL\": \"\",\n \"queryString\": \"\",\n \"leadClientIpAddress\": \"\",\n \"userAgentString\": \"\"\n },\n \"cookie\": \"\"\n }\n ],\n \"formId\": \"\",\n \"programId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"status\": \"updated\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"status\": \"created\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "971cea5c-3740-40bb-bfbc-1ef9e9e0e1fe", "name": "Associate Lead", "request": { "name": "Associate Lead", "description": { "content": "Associates a known Marketo lead record to a munchkin cookie and its associated web activity history. Required Permissions: Read-Write Lead", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "leads", ":leadId", "associate.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The cookie value to associate", "type": "text/plain" }, "key": "cookie", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "leadId", "disabled": false, "description": { "content": "(Required) The id of the lead to associate", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "d6d6b54a-03e9-48ca-94ee-5dec316f7e84", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "leads", ":leadId", "associate.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The cookie value to associate", "type": "text/plain" }, "key": "cookie", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The id of the lead to associate", "type": "text/plain" }, "type": "any", "value": "", "key": "leadId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"requestId\": \"\",\n \"success\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"nextPageToken\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "53c97219-92dd-4015-bbd5-3ea95e42e3f5", "name": "Get Lists by Lead Id", "request": { "name": "Get Lists by Lead Id", "description": { "content": "Query static list membership for one lead. Required Permissions: Read-Only Asset", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "leads", ":leadId", "listMembership.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "{{nextPageToken}}" }, { "disabled": true, "description": { "content": "Maximum number of records to return. Maximum and default is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "leadId", "disabled": false, "description": { "content": "(Required) The Marketo lead id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "90b0e73c-87cd-42b4-9c14-42dda37c0c1a", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "leads", ":leadId", "listMembership.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of records to return. Maximum and default is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The Marketo lead id", "type": "text/plain" }, "type": "any", "value": "", "key": "leadId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"createdAt\": \"\",\n \"listId\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"createdAt\": \"\",\n \"listId\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ab6962cc-e89a-4cd4-b5fe-e6a929420791", "name": "Merge Leads", "request": { "name": "Merge Leads", "description": { "content": "Merges two or more known lead records into a single lead record. Required Permissions: Read-Write Lead", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "leads", ":leadId", "merge.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "The id of the losing record", "type": "text/plain" }, "key": "leadId", "value": "" }, { "disabled": true, "description": { "content": "A comma-separated list of ids of losing records", "type": "text/plain" }, "key": "leadIds", "value": "" }, { "disabled": true, "description": { "content": "If set, will attempt to merge the designated records in a natively-synched CRM. Only valid for instances with are natively synched to SFDC.", "type": "text/plain" }, "key": "mergeInCRM", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "leadId", "disabled": false, "description": { "content": "(Required) The id of the winning lead record", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "5d08ade4-c616-4285-a206-4149a1cbd0ad", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "leads", ":leadId", "merge.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "The id of the losing record", "type": "text/plain" }, "key": "leadId", "value": "" }, { "disabled": true, "description": { "content": "A comma-separated list of ids of losing records", "type": "text/plain" }, "key": "leadIds", "value": "" }, { "disabled": true, "description": { "content": "If set, will attempt to merge the designated records in a natively-synched CRM. Only valid for instances with are natively synched to SFDC.", "type": "text/plain" }, "key": "mergeInCRM", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The id of the winning lead record", "type": "text/plain" }, "type": "any", "value": "", "key": "leadId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"requestId\": \"\",\n \"success\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"nextPageToken\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2d750d8d-cf6b-4449-9220-cf51bc56a036", "name": "Get Programs by Lead Id", "request": { "name": "Get Programs by Lead Id", "description": { "content": "Query program membership for one lead. Required Permissions: Read-Only Asset", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "leads", ":leadId", "programMembership.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "{{nextPageToken}}" }, { "disabled": true, "description": { "content": "Maximum number of records to return. Maximum and default is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "Exclude programs prior to this date. Must be valid ISO-8601 string. See Datetime field type description.", "type": "text/plain" }, "key": "earliestUpdatedAt", "value": "" }, { "disabled": true, "description": { "content": "Exclude programs after this date. Must be valid ISO-8601 string. See Datetime field type description.", "type": "text/plain" }, "key": "latestUpdatedAt", "value": "" }, { "disabled": true, "description": { "content": "Set to \"programId\" to filter a set of programs.", "type": "text/plain" }, "key": "filterType", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated list of program ids to match against", "type": "text/plain" }, "key": "filterValues", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "leadId", "disabled": false, "description": { "content": "(Required) The Marketo lead id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c2998a2d-61de-437b-a771-a43e0efd61ff", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "leads", ":leadId", "programMembership.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of records to return. Maximum and default is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "Exclude programs prior to this date. Must be valid ISO-8601 string. See Datetime field type description.", "type": "text/plain" }, "key": "earliestUpdatedAt", "value": "" }, { "disabled": true, "description": { "content": "Exclude programs after this date. Must be valid ISO-8601 string. See Datetime field type description.", "type": "text/plain" }, "key": "latestUpdatedAt", "value": "" }, { "disabled": true, "description": { "content": "Set to \"programId\" to filter a set of programs.", "type": "text/plain" }, "key": "filterType", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated list of program ids to match against", "type": "text/plain" }, "key": "filterValues", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The Marketo lead id", "type": "text/plain" }, "type": "any", "value": "", "key": "leadId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"progressionStatus\": \"\",\n \"isExhausted\": \"\",\n \"acquiredBy\": \"\",\n \"reachedSuccess\": \"\",\n \"membershipDate\": \"\",\n \"updatedAt\": \"\",\n \"nurtureCadence\": \"\",\n \"stream\": \"\"\n },\n {\n \"id\": \"\",\n \"progressionStatus\": \"\",\n \"isExhausted\": \"\",\n \"acquiredBy\": \"\",\n \"reachedSuccess\": \"\",\n \"membershipDate\": \"\",\n \"updatedAt\": \"\",\n \"nurtureCadence\": \"\",\n \"stream\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ea8327b1-013c-4b72-baed-de829391d563", "name": "Get Smart Campaigns by Lead Id", "request": { "name": "Get Smart Campaigns by Lead Id", "description": { "content": "Query smart campaign membership for one lead. Required Permissions: Read-Only Asset", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "leads", ":leadId", "smartCampaignMembership.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "{{nextPageToken}}" }, { "disabled": true, "description": { "content": "Maximum number of records to return. Maximum and default is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "Exclude smart campaigns prior to this date. Must be valid ISO-8601 string. See Datetime field type description.", "type": "text/plain" }, "key": "earliestUpdatedAt", "value": "" }, { "disabled": true, "description": { "content": "Exclude smart campaigns after this date. Must be valid ISO-8601 string. See Datetime field type description.", "type": "text/plain" }, "key": "latestUpdatedAt", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "leadId", "disabled": false, "description": { "content": "(Required) The Marketo lead id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "5e40893d-6311-4286-a545-557efa443c1c", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "leads", ":leadId", "smartCampaignMembership.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of records to return. Maximum and default is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "Exclude smart campaigns prior to this date. Must be valid ISO-8601 string. See Datetime field type description.", "type": "text/plain" }, "key": "earliestUpdatedAt", "value": "" }, { "disabled": true, "description": { "content": "Exclude smart campaigns after this date. Must be valid ISO-8601 string. See Datetime field type description.", "type": "text/plain" }, "key": "latestUpdatedAt", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The Marketo lead id", "type": "text/plain" }, "type": "any", "value": "", "key": "leadId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"createdAt\": \"\",\n \"smartCampaignId\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"createdAt\": \"\",\n \"smartCampaignId\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e1e39405-d491-41f6-90d3-42b1e7dbe5f9", "name": "Describe Program Member", "request": { "name": "Describe Program Member", "description": { "content": "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

Note: This endpoint has been superseded. Use Describe Program Member endpoint instead.", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "program", "members", "describe.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "75714ed6-b88b-4c1f-bced-396fdaf2893b", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "program", "members", "describe.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"fields\": [\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"dataType\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\",\n \"length\": \"\"\n },\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"dataType\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\",\n \"length\": \"\"\n }\n ],\n \"name\": \"\"\n },\n {\n \"fields\": [\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"dataType\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\",\n \"length\": \"\"\n },\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"dataType\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\",\n \"length\": \"\"\n }\n ],\n \"name\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Activities", "description": "Read activity, lead-change, and deleted-lead records from the activity log, and create or manage custom activity types.", "item": [ { "id": "322dee11-fde9-4740-a92b-46bd433ebd9a", "name": "Get Lead Activities", "request": { "name": "Get Lead Activities", "description": { "content": "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", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "activities.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token representation of a datetime returned by the Get Paging Token endpoint. This endpoint will return activities after this datetime", "type": "text/plain" }, "key": "nextPageToken", "value": "{{nextPageToken}}" }, { "disabled": false, "description": { "content": "(Required) Comma-separated list of activity type ids. These can be retrieved with the Get Activity Types API.", "type": "text/plain" }, "key": "activityTypeIds", "value": "" }, { "disabled": true, "description": { "content": "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", "type": "text/plain" }, "key": "assetIds", "value": "" }, { "disabled": true, "description": { "content": "Id of a static list. If set, will only return activities of members of this static list.", "type": "text/plain" }, "key": "listId", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated list of lead ids. If set, will only return activities of the leads with these ids. Allows up to 30 entries.", "type": "text/plain" }, "key": "leadIds", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of records to return. Maximum and default is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a5a4d55d-40dd-4e29-9bf3-2a3421c17421", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "activities.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token representation of a datetime returned by the Get Paging Token endpoint. This endpoint will return activities after this datetime", "type": "text/plain" }, "key": "nextPageToken", "value": "" }, { "disabled": false, "description": { "content": "(Required) Comma-separated list of activity type ids. These can be retrieved with the Get Activity Types API.", "type": "text/plain" }, "key": "activityTypeIds", "value": "" }, { "disabled": true, "description": { "content": "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", "type": "text/plain" }, "key": "assetIds", "value": "" }, { "disabled": true, "description": { "content": "Id of a static list. If set, will only return activities of members of this static list.", "type": "text/plain" }, "key": "listId", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated list of lead ids. If set, will only return activities of the leads with these ids. Allows up to 30 entries.", "type": "text/plain" }, "key": "leadIds", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of records to return. Maximum and default is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"activityDate\": \"\",\n \"activityTypeId\": \"\",\n \"attributes\": [\n {\n \"name\": \"\",\n \"value\": {},\n \"apiName\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": {},\n \"apiName\": \"\"\n }\n ],\n \"id\": \"\",\n \"leadId\": \"\",\n \"campaignId\": \"\",\n \"marketoGUID\": \"\",\n \"primaryAttributeValue\": \"\",\n \"primaryAttributeValueId\": \"\"\n },\n {\n \"activityDate\": \"\",\n \"activityTypeId\": \"\",\n \"attributes\": [\n {\n \"name\": \"\",\n \"value\": {},\n \"apiName\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": {},\n \"apiName\": \"\"\n }\n ],\n \"id\": \"\",\n \"leadId\": \"\",\n \"campaignId\": \"\",\n \"marketoGUID\": \"\",\n \"primaryAttributeValue\": \"\",\n \"primaryAttributeValueId\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "041e2787-5f53-4563-845d-46eb447db43e", "name": "Get Deleted Leads", "request": { "name": "Get Deleted Leads", "description": { "content": "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", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "activities", "deletedleads.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token representation of a datetime returned by the Get Paging Token endpoint. This endpoint will return activities after this datetime", "type": "text/plain" }, "key": "nextPageToken", "value": "{{nextPageToken}}" }, { "disabled": true, "description": { "content": "Maximum number of records to return. Maximum and default is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "84f2549c-7616-43f8-b015-30558935f3d3", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "activities", "deletedleads.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token representation of a datetime returned by the Get Paging Token endpoint. This endpoint will return activities after this datetime", "type": "text/plain" }, "key": "nextPageToken", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of records to return. Maximum and default is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"activityDate\": \"\",\n \"activityTypeId\": \"\",\n \"attributes\": [\n {\n \"name\": \"\",\n \"value\": {},\n \"apiName\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": {},\n \"apiName\": \"\"\n }\n ],\n \"id\": \"\",\n \"leadId\": \"\",\n \"campaignId\": \"\",\n \"marketoGUID\": \"\",\n \"primaryAttributeValue\": \"\",\n \"primaryAttributeValueId\": \"\"\n },\n {\n \"activityDate\": \"\",\n \"activityTypeId\": \"\",\n \"attributes\": [\n {\n \"name\": \"\",\n \"value\": {},\n \"apiName\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": {},\n \"apiName\": \"\"\n }\n ],\n \"id\": \"\",\n \"leadId\": \"\",\n \"campaignId\": \"\",\n \"marketoGUID\": \"\",\n \"primaryAttributeValue\": \"\",\n \"primaryAttributeValueId\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1e92cf0e-09e6-4959-9698-7dde46f18d70", "name": "Add Custom Activities", "request": { "name": "Add Custom Activities", "description": { "content": "Allows insertion of custom activities associated to given lead records. Requires provisioning of custom activity types to utilize. Required Permissions: Read-Write Activity", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "activities", "external.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"activityDate\": \"\",\n \"activityTypeId\": \"\",\n \"attributes\": [\n {\n \"name\": \"\",\n \"value\": {},\n \"apiName\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": {},\n \"apiName\": \"\"\n }\n ],\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"id\": \"\",\n \"leadId\": \"\",\n \"primaryAttributeValue\": \"\",\n \"apiName\": \"\",\n \"marketoGUID\": \"\",\n \"status\": \"removed\"\n },\n {\n \"activityDate\": \"\",\n \"activityTypeId\": \"\",\n \"attributes\": [\n {\n \"name\": \"\",\n \"value\": {},\n \"apiName\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": {},\n \"apiName\": \"\"\n }\n ],\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"id\": \"\",\n \"leadId\": \"\",\n \"primaryAttributeValue\": \"\",\n \"apiName\": \"\",\n \"marketoGUID\": \"\",\n \"status\": \"created\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e962d5e0-7b64-4f6e-8919-4e9c675a8519", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "activities", "external.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"activityDate\": \"\",\n \"activityTypeId\": \"\",\n \"attributes\": [\n {\n \"name\": \"\",\n \"value\": {},\n \"apiName\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": {},\n \"apiName\": \"\"\n }\n ],\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"id\": \"\",\n \"leadId\": \"\",\n \"primaryAttributeValue\": \"\",\n \"apiName\": \"\",\n \"marketoGUID\": \"\",\n \"status\": \"removed\"\n },\n {\n \"activityDate\": \"\",\n \"activityTypeId\": \"\",\n \"attributes\": [\n {\n \"name\": \"\",\n \"value\": {},\n \"apiName\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": {},\n \"apiName\": \"\"\n }\n ],\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"id\": \"\",\n \"leadId\": \"\",\n \"primaryAttributeValue\": \"\",\n \"apiName\": \"\",\n \"marketoGUID\": \"\",\n \"status\": \"created\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"activityDate\": \"\",\n \"activityTypeId\": \"\",\n \"attributes\": [\n {\n \"name\": \"\",\n \"value\": {},\n \"apiName\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": {},\n \"apiName\": \"\"\n }\n ],\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"id\": \"\",\n \"leadId\": \"\",\n \"primaryAttributeValue\": \"\",\n \"apiName\": \"\",\n \"marketoGUID\": \"\",\n \"status\": \"updated\"\n },\n {\n \"activityDate\": \"\",\n \"activityTypeId\": \"\",\n \"attributes\": [\n {\n \"name\": \"\",\n \"value\": {},\n \"apiName\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": {},\n \"apiName\": \"\"\n }\n ],\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"id\": \"\",\n \"leadId\": \"\",\n \"primaryAttributeValue\": \"\",\n \"apiName\": \"\",\n \"marketoGUID\": \"\",\n \"status\": \"deleted\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fd601478-b48a-4334-b2c7-8a4a24c0f5ab", "name": "Create Custom Activity Type", "request": { "name": "Create Custom Activity Type", "description": { "content": "Creates a new custom activity type draft in the target instance. Required Permissions: Read-Write Activity Metadata", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "activities", "external", "type.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apiName\": \"\",\n \"name\": \"\",\n \"triggerName\": \"\",\n \"filterName\": \"\",\n \"primaryAttribute\": {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"currency\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "3ef06cda-c8be-4005-9867-13f76f216dc3", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "activities", "external", "type.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apiName\": \"\",\n \"name\": \"\",\n \"triggerName\": \"\",\n \"filterName\": \"\",\n \"primaryAttribute\": {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"currency\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"apiName\": \"\",\n \"attributes\": [\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"date\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"currency\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n }\n ],\n \"createdAt\": \"\",\n \"description\": \"\",\n \"filterName\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"primaryAttribute\": {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"currency\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n \"status\": \"draft\",\n \"triggerName\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"apiName\": \"\",\n \"attributes\": [\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"link\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"date\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n }\n ],\n \"createdAt\": \"\",\n \"description\": \"\",\n \"filterName\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"primaryAttribute\": {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"text\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n \"status\": \"approved\",\n \"triggerName\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1affb98e-7a35-44f8-82c5-b54ebef21fa4", "name": "Update Custom Activity Type", "request": { "name": "Update Custom Activity Type", "description": { "content": "Updates the target custom activity type. All changes are applied to the draft version of the type. Required Permissions: Read-Write Activity Metadata", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "activities", "external", "type", "{{apiName}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apiName\": \"\",\n \"name\": \"\",\n \"triggerName\": \"\",\n \"filterName\": \"\",\n \"primaryAttribute\": {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"currency\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "0a8abadb-609c-4d7f-9d35-22457b5e8af0", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "activities", "external", "type", "{{apiName}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apiName\": \"\",\n \"name\": \"\",\n \"triggerName\": \"\",\n \"filterName\": \"\",\n \"primaryAttribute\": {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"currency\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"apiName\": \"\",\n \"attributes\": [\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"date\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"currency\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n }\n ],\n \"createdAt\": \"\",\n \"description\": \"\",\n \"filterName\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"primaryAttribute\": {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"currency\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n \"status\": \"draft\",\n \"triggerName\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"apiName\": \"\",\n \"attributes\": [\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"link\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"date\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n }\n ],\n \"createdAt\": \"\",\n \"description\": \"\",\n \"filterName\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"primaryAttribute\": {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"text\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n \"status\": \"approved\",\n \"triggerName\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f24e0710-e238-4bc2-a417-107a703f170b", "name": "Approve Custom Activity Type", "request": { "name": "Approve Custom Activity Type", "description": { "content": "Approves 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", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "activities", "external", "type", ":apiName", "approve.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "apiName", "disabled": false, "description": { "content": "(Required) API Name of the activity type", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "c2adc76f-acac-4a49-99f2-107502002f55", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "activities", "external", "type", ":apiName", "approve.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) API Name of the activity type", "type": "text/plain" }, "type": "any", "value": "", "key": "apiName" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"apiName\": \"\",\n \"attributes\": [\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"date\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"currency\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n }\n ],\n \"createdAt\": \"\",\n \"description\": \"\",\n \"filterName\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"primaryAttribute\": {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"currency\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n \"status\": \"draft\",\n \"triggerName\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"apiName\": \"\",\n \"attributes\": [\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"link\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"date\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n }\n ],\n \"createdAt\": \"\",\n \"description\": \"\",\n \"filterName\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"primaryAttribute\": {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"text\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n \"status\": \"approved\",\n \"triggerName\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9ab61c54-3938-4adf-8bf3-fb37bde84336", "name": "Create Custom Activity Type Attributes", "request": { "name": "Create Custom Activity Type Attributes", "description": { "content": "Adds activity attributes to the target type. These are added to the draft version of the type. Required Permissions: Read-Write Activity Metadata", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "activities", "external", "type", ":apiName", "attributes", "create.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "apiName", "disabled": false, "description": { "content": "(Required) API Name of the activity type", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"attributes\": [\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"email\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"text\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "43632478-8469-4657-9a95-9e6eeaac1895", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "activities", "external", "type", ":apiName", "attributes", "create.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) API Name of the activity type", "type": "text/plain" }, "type": "any", "value": "", "key": "apiName" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"attributes\": [\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"email\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"text\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"apiName\": \"\",\n \"attributes\": [\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"date\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"currency\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n }\n ],\n \"createdAt\": \"\",\n \"description\": \"\",\n \"filterName\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"primaryAttribute\": {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"currency\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n \"status\": \"draft\",\n \"triggerName\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"apiName\": \"\",\n \"attributes\": [\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"link\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"date\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n }\n ],\n \"createdAt\": \"\",\n \"description\": \"\",\n \"filterName\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"primaryAttribute\": {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"text\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n \"status\": \"approved\",\n \"triggerName\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "60bf4d55-556a-4083-8915-56d09e382694", "name": "Delete Custom Activity Type Attributes", "request": { "name": "Delete Custom Activity Type Attributes", "description": { "content": "Deletes 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", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "activities", "external", "type", ":apiName", "attributes", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "apiName", "disabled": false, "description": { "content": "(Required) API Name of the activity type", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"attributes\": [\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"email\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"text\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "1e367670-8f56-4b75-9200-0429efa6b248", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "activities", "external", "type", ":apiName", "attributes", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) API Name of the activity type", "type": "text/plain" }, "type": "any", "value": "", "key": "apiName" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"attributes\": [\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"email\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"text\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"apiName\": \"\",\n \"attributes\": [\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"date\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"currency\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n }\n ],\n \"createdAt\": \"\",\n \"description\": \"\",\n \"filterName\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"primaryAttribute\": {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"currency\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n \"status\": \"draft\",\n \"triggerName\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"apiName\": \"\",\n \"attributes\": [\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"link\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"date\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n }\n ],\n \"createdAt\": \"\",\n \"description\": \"\",\n \"filterName\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"primaryAttribute\": {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"text\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n \"status\": \"approved\",\n \"triggerName\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "27714f94-5af8-4853-8e80-8bb20da9da7c", "name": "Update Custom Activity Type Attributes", "request": { "name": "Update Custom Activity Type Attributes", "description": { "content": "Updates 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", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "activities", "external", "type", ":apiName", "attributes", "update.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "apiName", "disabled": false, "description": { "content": "(Required) API Name of the activity type", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"attributes\": [\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"email\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"text\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "6acd431f-41a7-45e5-b411-bbdc744aa501", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "activities", "external", "type", ":apiName", "attributes", "update.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) API Name of the activity type", "type": "text/plain" }, "type": "any", "value": "", "key": "apiName" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"attributes\": [\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"email\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"text\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"apiName\": \"\",\n \"attributes\": [\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"date\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"currency\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n }\n ],\n \"createdAt\": \"\",\n \"description\": \"\",\n \"filterName\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"primaryAttribute\": {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"currency\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n \"status\": \"draft\",\n \"triggerName\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"apiName\": \"\",\n \"attributes\": [\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"link\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"date\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n }\n ],\n \"createdAt\": \"\",\n \"description\": \"\",\n \"filterName\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"primaryAttribute\": {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"text\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n \"status\": \"approved\",\n \"triggerName\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6ae9838a-5de2-44b3-a4c5-ce702c6acd1b", "name": "Delete Custom Activity Type", "request": { "name": "Delete Custom Activity Type", "description": { "content": "Deletes 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", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "activities", "external", "type", ":apiName", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "apiName", "disabled": false, "description": { "content": "(Required) API Name of the activity type", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "7974b711-434c-4715-8f04-71a2979e44c4", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "activities", "external", "type", ":apiName", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) API Name of the activity type", "type": "text/plain" }, "type": "any", "value": "", "key": "apiName" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"apiName\": \"\",\n \"attributes\": [\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"date\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"currency\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n }\n ],\n \"createdAt\": \"\",\n \"description\": \"\",\n \"filterName\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"primaryAttribute\": {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"currency\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n \"status\": \"draft\",\n \"triggerName\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"apiName\": \"\",\n \"attributes\": [\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"link\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"date\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n }\n ],\n \"createdAt\": \"\",\n \"description\": \"\",\n \"filterName\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"primaryAttribute\": {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"text\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n \"status\": \"approved\",\n \"triggerName\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "25af5440-0374-4c9a-b3a9-1050eca9c60a", "name": "Describe Custom Activity Type", "request": { "name": "Describe Custom Activity Type", "description": { "content": "Returns metadata for a specific custom activity type. Required Permissions: Read-Only Activity Metadata, Read-Write Activity Metadata", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "activities", "external", "type", ":apiName", "describe.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "draft", "type": "text/plain" }, "key": "draft", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "apiName", "disabled": false, "description": { "content": "(Required) API Name of the activity type", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "5b147861-20de-4c1f-b6b0-83b478331d98", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "activities", "external", "type", ":apiName", "describe.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "draft", "type": "text/plain" }, "key": "draft", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) API Name of the activity type", "type": "text/plain" }, "type": "any", "value": "", "key": "apiName" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"apiName\": \"\",\n \"attributes\": [\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"date\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"currency\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n }\n ],\n \"createdAt\": \"\",\n \"description\": \"\",\n \"filterName\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"primaryAttribute\": {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"currency\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n \"status\": \"draft\",\n \"triggerName\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"apiName\": \"\",\n \"attributes\": [\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"link\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"date\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n }\n ],\n \"createdAt\": \"\",\n \"description\": \"\",\n \"filterName\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"primaryAttribute\": {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"text\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n \"status\": \"approved\",\n \"triggerName\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "991a8663-45aa-4330-af55-2fcb2868b28f", "name": "Discard Custom Activity Type Draft", "request": { "name": "Discard Custom Activity Type Draft", "description": { "content": "Discards the current draft of the custom activity type. Required Permissions: Read-Write Activity Metadata", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "activities", "external", "type", ":apiName", "discardDraft.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "apiName", "disabled": false, "description": { "content": "(Required) API Name of the activity type", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "3655bbc2-6116-4513-9760-8dcbb7dd6d8d", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "activities", "external", "type", ":apiName", "discardDraft.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) API Name of the activity type", "type": "text/plain" }, "type": "any", "value": "", "key": "apiName" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"apiName\": \"\",\n \"attributes\": [\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"date\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"currency\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n }\n ],\n \"createdAt\": \"\",\n \"description\": \"\",\n \"filterName\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"primaryAttribute\": {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"currency\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n \"status\": \"draft\",\n \"triggerName\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"apiName\": \"\",\n \"attributes\": [\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"link\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"date\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n }\n ],\n \"createdAt\": \"\",\n \"description\": \"\",\n \"filterName\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"primaryAttribute\": {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"text\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n \"status\": \"approved\",\n \"triggerName\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5a0cf754-0b84-49c3-aa61-8e3c31f37ea7", "name": "Get Custom Activity Types", "request": { "name": "Get Custom Activity Types", "description": { "content": "Returns metadata regarding custom activities provisioned in the target instance. Required Permissions: Read-Only Activity Metadata, Read-Write Activity Metadata", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "activities", "external", "types.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ce7eda73-a028-4af3-a470-7757bc28a177", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "activities", "external", "types.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"apiName\": \"\",\n \"attributes\": [\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"date\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"currency\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n }\n ],\n \"createdAt\": \"\",\n \"description\": \"\",\n \"filterName\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"primaryAttribute\": {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"currency\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n \"status\": \"draft\",\n \"triggerName\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"apiName\": \"\",\n \"attributes\": [\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"link\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"date\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n }\n ],\n \"createdAt\": \"\",\n \"description\": \"\",\n \"filterName\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"primaryAttribute\": {\n \"apiName\": \"\",\n \"name\": \"\",\n \"dataType\": \"text\",\n \"description\": \"\",\n \"isPrimary\": \"\"\n },\n \"status\": \"approved\",\n \"triggerName\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5574f0dd-bc5a-4ee9-ad0b-c4326b47788f", "name": "Get Lead Changes", "request": { "name": "Get Lead Changes", "description": { "content": "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", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "activities", "leadchanges.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token representation of a datetime returned by the Get Paging Token endpoint. This endpoint will return activities after this datetime", "type": "text/plain" }, "key": "nextPageToken", "value": "{{nextPageToken}}" }, { "disabled": false, "description": { "content": "(Required) Comma-separated list of field names to return changes for. Field names can be retrieved with the Describe Lead API.", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "Id of a static list. If set, will only return activities of members of this static list.", "type": "text/plain" }, "key": "listId", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated list of lead ids. If set, will only return activities of the leads with these ids. Allows up to 30 entries.", "type": "text/plain" }, "key": "leadIds", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of records to return. Maximum and default is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "05dd9f79-2949-4a85-a668-7494e4198aac", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "activities", "leadchanges.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token representation of a datetime returned by the Get Paging Token endpoint. This endpoint will return activities after this datetime", "type": "text/plain" }, "key": "nextPageToken", "value": "" }, { "disabled": false, "description": { "content": "(Required) Comma-separated list of field names to return changes for. Field names can be retrieved with the Describe Lead API.", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "Id of a static list. If set, will only return activities of members of this static list.", "type": "text/plain" }, "key": "listId", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated list of lead ids. If set, will only return activities of the leads with these ids. Allows up to 30 entries.", "type": "text/plain" }, "key": "leadIds", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of records to return. Maximum and default is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"activityDate\": \"\",\n \"activityTypeId\": \"\",\n \"attributes\": [\n {\n \"name\": \"\",\n \"value\": {},\n \"apiName\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": {},\n \"apiName\": \"\"\n }\n ],\n \"id\": \"\",\n \"leadId\": \"\",\n \"campaignId\": \"\",\n \"fields\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"newValue\": \"\",\n \"oldValue\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"newValue\": \"\",\n \"oldValue\": \"\"\n }\n ],\n \"marketoGUID\": \"\"\n },\n {\n \"activityDate\": \"\",\n \"activityTypeId\": \"\",\n \"attributes\": [\n {\n \"name\": \"\",\n \"value\": {},\n \"apiName\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": {},\n \"apiName\": \"\"\n }\n ],\n \"id\": \"\",\n \"leadId\": \"\",\n \"campaignId\": \"\",\n \"fields\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"newValue\": \"\",\n \"oldValue\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"newValue\": \"\",\n \"oldValue\": \"\"\n }\n ],\n \"marketoGUID\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1dc2fbc4-c01e-452a-87bb-41307201d05a", "name": "Get Paging Token", "request": { "name": "Get Paging Token", "description": { "content": "Returns a paging token for use in retrieving activities and data value changes. Required Permissions: Read-Only Activity, Read-Write Activity", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "activities", "pagingtoken.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Earliest datetime to retrieve activities from", "type": "text/plain" }, "key": "sinceDatetime", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "297ad5c5-3fdd-4de6-88ef-1c5f8f324758", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "activities", "pagingtoken.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Earliest datetime to retrieve activities from", "type": "text/plain" }, "key": "sinceDatetime", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fad1c9bd-002b-4138-8a56-131cbf9dc740", "name": "Get Activity Types", "request": { "name": "Get Activity Types", "description": { "content": "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", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "activities", "types.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "7eb23ac5-317f-4676-808e-039f07780be3", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "activities", "types.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"attributes\": [\n {\n \"dataType\": \"\",\n \"name\": \"\",\n \"apiName\": \"\"\n },\n {\n \"dataType\": \"\",\n \"name\": \"\",\n \"apiName\": \"\"\n }\n ],\n \"id\": \"\",\n \"name\": \"\",\n \"primaryAttribute\": {\n \"dataType\": \"\",\n \"name\": \"\",\n \"apiName\": \"\"\n },\n \"apiName\": \"\",\n \"description\": \"\"\n },\n {\n \"attributes\": [\n {\n \"dataType\": \"\",\n \"name\": \"\",\n \"apiName\": \"\"\n },\n {\n \"dataType\": \"\",\n \"name\": \"\",\n \"apiName\": \"\"\n }\n ],\n \"id\": \"\",\n \"name\": \"\",\n \"primaryAttribute\": {\n \"dataType\": \"\",\n \"name\": \"\",\n \"apiName\": \"\"\n },\n \"apiName\": \"\",\n \"description\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Campaigns", "description": "List Smart Campaigns, trigger them for a set of leads, and schedule or clone campaign runs.", "item": [ { "id": "3fccd77f-18b5-4c27-be5f-f0f73c1d0a2c", "name": "Get Campaigns", "request": { "name": "Get Campaigns", "description": { "content": "Returns a list of campaign records. Required Permissions: Read-Only Campaigns, Read-Write Campaigns

Note: This endpoint has been superseded. Use Get Smart Campaigns endpoint instead.", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "campaigns.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Comma-separated list of campaign ids to return records for", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated list of names to filter on", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated list of program names to filter on. If set, will filter to only campaigns which are children of the designated programs.", "type": "text/plain" }, "key": "programName", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated list of workspace names to filter on. If set, will only return campaigns in the given workspaces.", "type": "text/plain" }, "key": "workspaceName", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of records to return. Maximum and default is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "{{nextPageToken}}" }, { "disabled": true, "description": { "content": "Set to true to return active Campaigns which have a Campaign is Requested trigger and source is Web Service API", "type": "text/plain" }, "key": "isTriggerable", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b30d0ddc-eb30-41b1-a3d4-fff9d6dc94b0", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "campaigns.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Comma-separated list of campaign ids to return records for", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated list of names to filter on", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated list of program names to filter on. If set, will filter to only campaigns which are children of the designated programs.", "type": "text/plain" }, "key": "programName", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated list of workspace names to filter on. If set, will only return campaigns in the given workspaces.", "type": "text/plain" }, "key": "workspaceName", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of records to return. Maximum and default is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "" }, { "disabled": true, "description": { "content": "Set to true to return active Campaigns which have a Campaign is Requested trigger and source is Web Service API", "type": "text/plain" }, "key": "isTriggerable", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"createdAt\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"trigger\",\n \"updatedAt\": \"\",\n \"active\": \"\",\n \"description\": \"\",\n \"programId\": \"\",\n \"programName\": \"\",\n \"workspaceName\": \"\"\n },\n {\n \"createdAt\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"batch\",\n \"updatedAt\": \"\",\n \"active\": \"\",\n \"description\": \"\",\n \"programId\": \"\",\n \"programName\": \"\",\n \"workspaceName\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "98d0082d-2c47-4fb4-ba74-501c46c4dacc", "name": "Get Campaign By Id", "request": { "name": "Get Campaign By Id", "description": { "content": "Returns the record of a campaign by its id. Required Permissions: Read-Only Campaigns, Read-Write Campaigns

Note: This endpoint has been superseded. Use Get Smart Campaign by Id endpoint instead.", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "campaigns", "{{campaignId}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3edf2987-5a5f-46d5-a406-37b1df0fc592", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "campaigns", "{{campaignId}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"createdAt\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"trigger\",\n \"updatedAt\": \"\",\n \"active\": \"\",\n \"description\": \"\",\n \"programId\": \"\",\n \"programName\": \"\",\n \"workspaceName\": \"\"\n },\n {\n \"createdAt\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"batch\",\n \"updatedAt\": \"\",\n \"active\": \"\",\n \"description\": \"\",\n \"programId\": \"\",\n \"programName\": \"\",\n \"workspaceName\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c69e9b91-5dc0-4161-b398-977449638a52", "name": "Schedule Campaign", "request": { "name": "Schedule Campaign", "description": { "content": "Remotely 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", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "campaigns", ":campaignId", "schedule.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "campaignId", "disabled": false, "description": { "content": "(Required) Id of the batch campaign to schedule.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"cloneToProgramName\": \"\",\n \"runAt\": \"\",\n \"tokens\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d5b93f5b-3976-4c0f-a610-d7b473ccf09b", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "campaigns", ":campaignId", "schedule.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the batch campaign to schedule.", "type": "text/plain" }, "type": "any", "value": "", "key": "campaignId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"cloneToProgramName\": \"\",\n \"runAt\": \"\",\n \"tokens\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"createdAt\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"trigger\",\n \"updatedAt\": \"\",\n \"active\": \"\",\n \"description\": \"\",\n \"programId\": \"\",\n \"programName\": \"\",\n \"workspaceName\": \"\"\n },\n {\n \"createdAt\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"batch\",\n \"updatedAt\": \"\",\n \"active\": \"\",\n \"description\": \"\",\n \"programId\": \"\",\n \"programName\": \"\",\n \"workspaceName\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "22c18b44-0d06-4004-a459-2ce9ddedd7b3", "name": "Request Campaign", "request": { "name": "Request Campaign", "description": { "content": "Passes 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", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "campaigns", ":campaignId", "trigger.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "campaignId", "disabled": false, "description": { "content": "(Required) The id of the campaign to trigger", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"leads\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"tokens\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "b7ba2223-bf37-4d5f-908d-c6fadfe04b07", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "campaigns", ":campaignId", "trigger.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The id of the campaign to trigger", "type": "text/plain" }, "type": "any", "value": "", "key": "campaignId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"leads\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"tokens\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"createdAt\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"trigger\",\n \"updatedAt\": \"\",\n \"active\": \"\",\n \"description\": \"\",\n \"programId\": \"\",\n \"programName\": \"\",\n \"workspaceName\": \"\"\n },\n {\n \"createdAt\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"batch\",\n \"updatedAt\": \"\",\n \"active\": \"\",\n \"description\": \"\",\n \"programId\": \"\",\n \"programName\": \"\",\n \"workspaceName\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Program Members", "description": "Read and write program membership, member statuses, and custom program member fields.", "item": [ { "id": "b8ae6d4f-806a-4591-9f68-87f1383d76da", "name": "Describe Program Member", "request": { "name": "Describe Program Member", "description": { "content": "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", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "programs", "members", "describe.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "93afe3c7-0acf-4565-9520-1613e1493f8d", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "programs", "members", "describe.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"dedupeFields\": [\n \"\",\n \"\"\n ],\n \"searchableFields\": [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ],\n \"fields\": [\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"dataType\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\",\n \"length\": \"\"\n },\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"dataType\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\",\n \"length\": \"\"\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"dedupeFields\": [\n \"\",\n \"\"\n ],\n \"searchableFields\": [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ],\n \"fields\": [\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"dataType\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\",\n \"length\": \"\"\n },\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"dataType\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\",\n \"length\": \"\"\n }\n ]\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1d64a82b-265f-4adf-8b9a-111285113e4f", "name": "Get Program Member Fields", "request": { "name": "Get Program Member Fields", "description": { "content": "Retrieves metadata for all program member fields in the target instance. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "programs", "members", "schema", "fields.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "{{nextPageToken}}" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4eec46ec-1880-48f3-9527-b097c5d01402", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "programs", "members", "schema", "fields.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"displayName\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"dataType\": \"\",\n \"isHidden\": \"\",\n \"isHtmlEncodingInEmail\": \"\",\n \"isSensitive\": \"\",\n \"isCustom\": \"\",\n \"isApiCreated\": \"\",\n \"length\": \"\"\n },\n {\n \"displayName\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"dataType\": \"\",\n \"isHidden\": \"\",\n \"isHtmlEncodingInEmail\": \"\",\n \"isSensitive\": \"\",\n \"isCustom\": \"\",\n \"isApiCreated\": \"\",\n \"length\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "791a085e-1744-483d-97f2-f822ab17fdc3", "name": "Create Program Member Fields", "request": { "name": "Create Program Member Fields", "description": { "content": "Create program member fields in the target instance. Required Permissions: Read-Write Schema Custom Field", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "programs", "members", "schema", "fields.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"displayName\": \"\",\n \"name\": \"\",\n \"dataType\": \"email\",\n \"description\": \"\",\n \"isHidden\": \"\",\n \"isHtmlEncodingInEmail\": \"\",\n \"isSensitive\": \"\"\n },\n {\n \"displayName\": \"\",\n \"name\": \"\",\n \"dataType\": \"integer\",\n \"description\": \"\",\n \"isHidden\": \"\",\n \"isHtmlEncodingInEmail\": \"\",\n \"isSensitive\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "57f87c76-6819-4db6-9f85-6a2d6ef19991", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "programs", "members", "schema", "fields.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"displayName\": \"\",\n \"name\": \"\",\n \"dataType\": \"email\",\n \"description\": \"\",\n \"isHidden\": \"\",\n \"isHtmlEncodingInEmail\": \"\",\n \"isSensitive\": \"\"\n },\n {\n \"displayName\": \"\",\n \"name\": \"\",\n \"dataType\": \"integer\",\n \"description\": \"\",\n \"isHidden\": \"\",\n \"isHtmlEncodingInEmail\": \"\",\n \"isSensitive\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"name\": \"\",\n \"status\": \"created\"\n },\n {\n \"name\": \"\",\n \"status\": \"updated\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9777c9c4-807f-4ff9-ad1d-b67ce7e7bf72", "name": "Get Program Member Field by Name", "request": { "name": "Get Program Member Field by Name", "description": { "content": "Retrieves metadata for single program member field. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "programs", "members", "schema", "fields", "{{fieldApiName}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "06e42629-e478-4858-866c-6f15f53e3f1e", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "programs", "members", "schema", "fields", "{{fieldApiName}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"displayName\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"dataType\": \"\",\n \"isHidden\": \"\",\n \"isHtmlEncodingInEmail\": \"\",\n \"isSensitive\": \"\",\n \"isCustom\": \"\",\n \"isApiCreated\": \"\",\n \"length\": \"\"\n },\n {\n \"displayName\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"dataType\": \"\",\n \"isHidden\": \"\",\n \"isHtmlEncodingInEmail\": \"\",\n \"isSensitive\": \"\",\n \"isCustom\": \"\",\n \"isApiCreated\": \"\",\n \"length\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "646218ad-cdf5-4f41-8fdc-b0b44fe93bfc", "name": "Update Program Member Field", "request": { "name": "Update Program Member Field", "description": { "content": "Update metadata for a program member field in the target instance. See update rules here. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "programs", "members", "schema", "fields", "{{fieldApiName}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"displayName\": \"\",\n \"description\": \"\",\n \"isHidden\": \"\",\n \"isHtmlEncodingInEmail\": \"\",\n \"isSensitive\": \"\"\n },\n {\n \"displayName\": \"\",\n \"description\": \"\",\n \"isHidden\": \"\",\n \"isHtmlEncodingInEmail\": \"\",\n \"isSensitive\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "426cfddd-94fb-4185-89cc-2db92cb86008", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "programs", "members", "schema", "fields", "{{fieldApiName}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"displayName\": \"\",\n \"description\": \"\",\n \"isHidden\": \"\",\n \"isHtmlEncodingInEmail\": \"\",\n \"isSensitive\": \"\"\n },\n {\n \"displayName\": \"\",\n \"description\": \"\",\n \"isHidden\": \"\",\n \"isHtmlEncodingInEmail\": \"\",\n \"isSensitive\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"name\": \"\",\n \"status\": \"created\"\n },\n {\n \"name\": \"\",\n \"status\": \"updated\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8ad2ac15-e9a1-4a36-8186-5b0665559de6", "name": "Get Program Members", "request": { "name": "Get Program Members", "description": { "content": "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\u2019s dataType must be either \u201cstring\u201d or \u201cinteger\u201d. If you specify a filterType other than \u201cleadId\u201d, a maximum of 100,000 program member records can be processed by the request. Required Permissions: Read-Only Lead, Read-Write Lead", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "programs", ":programId", "members.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) 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 endpoint.", "type": "text/plain" }, "key": "filterType", "value": "" }, { "disabled": false, "description": { "content": "(Required) A comma-separated list of values to filter on in the specified fields.", "type": "text/plain" }, "key": "filterValues", "value": "" }, { "disabled": true, "description": { "content": "When using filterType=updatedAt, the start of date range filter (ISO 8601-format)", "type": "text/plain" }, "key": "startAt", "value": "" }, { "disabled": true, "description": { "content": "When using filterType=updatedAt, the end of date range filter (ISO 8601-format)", "type": "text/plain" }, "key": "endAt", "value": "" }, { "disabled": true, "description": { "content": "A comma-separated list of lead fields to return for each record.", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "{{nextPageToken}}" } ], "variable": [ { "type": "any", "value": "", "key": "programId", "disabled": false, "description": { "content": "(Required) The id of target program.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4adb31a8-422c-4dea-9d72-ac6f5d4d067a", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "programs", ":programId", "members.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) 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 endpoint.", "type": "text/plain" }, "key": "filterType", "value": "" }, { "disabled": false, "description": { "content": "(Required) A comma-separated list of values to filter on in the specified fields.", "type": "text/plain" }, "key": "filterValues", "value": "" }, { "disabled": true, "description": { "content": "When using filterType=updatedAt, the start of date range filter (ISO 8601-format)", "type": "text/plain" }, "key": "startAt", "value": "" }, { "disabled": true, "description": { "content": "When using filterType=updatedAt, the end of date range filter (ISO 8601-format)", "type": "text/plain" }, "key": "endAt", "value": "" }, { "disabled": true, "description": { "content": "A comma-separated list of lead fields to return for each record.", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The id of target program.", "type": "text/plain" }, "type": "any", "value": "", "key": "programId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"seq\": \"\",\n \"leadId\": \"\",\n \"reachedSuccess\": \"\",\n \"programId\": \"\",\n \"acquiredBy\": \"\",\n \"membershipDate\": \"\"\n },\n {\n \"seq\": \"\",\n \"leadId\": \"\",\n \"reachedSuccess\": \"\",\n \"programId\": \"\",\n \"acquiredBy\": \"\",\n \"membershipDate\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d13fa34e-00fb-4fd0-9fe9-9e890556c862", "name": "Sync Program Member Data", "request": { "name": "Sync Program Member Data", "description": { "content": "Changes 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", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "programs", ":programId", "members.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "programId", "disabled": false, "description": { "content": "(Required) The id of target program.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"leadId\": \"\",\n \"{fieldApiName}\": \"\",\n \"{fieldApiName2}\": \"\"\n },\n {\n \"leadId\": \"\",\n \"{fieldApiName}\": \"\",\n \"{fieldApiName2}\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "2093a1da-a8ae-4487-a6f1-7f12589a081c", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "programs", ":programId", "members.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The id of target program.", "type": "text/plain" }, "type": "any", "value": "", "key": "programId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"leadId\": \"\",\n \"{fieldApiName}\": \"\",\n \"{fieldApiName2}\": \"\"\n },\n {\n \"leadId\": \"\",\n \"{fieldApiName}\": \"\",\n \"{fieldApiName2}\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"status\": \"skipped\",\n \"leadId\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"status\": \"updated\",\n \"leadId\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bb421896-96ba-4943-b05f-49974b3ee9e9", "name": "Delete Program Members", "request": { "name": "Delete Program Members", "description": { "content": "Delete a list of members from the destination instance. Required Permissions: Read-Write Lead", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "programs", ":programId", "members", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "programId", "disabled": false, "description": { "content": "(Required) The id of target program.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"leadId\": \"\"\n },\n {\n \"leadId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ad9793bb-0418-4c2b-b2b5-a2fdb61b9ca8", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "programs", ":programId", "members", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The id of target program.", "type": "text/plain" }, "type": "any", "value": "", "key": "programId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"leadId\": \"\"\n },\n {\n \"leadId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"status\": \"deleted\",\n \"leadId\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"status\": \"skipped\",\n \"leadId\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e0a58bac-8752-4c1c-910a-0326c8d2a291", "name": "Sync Program Member Status", "request": { "name": "Sync Program Member Status", "description": { "content": "Changes 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", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "programs", ":programId", "members", "status.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "programId", "disabled": false, "description": { "content": "(Required) The id of target program.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"statusName\": \"\",\n \"input\": [\n {\n \"leadId\": \"\"\n },\n {\n \"leadId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "07aae027-82c3-43bd-a13f-ac7c2b076684", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "programs", ":programId", "members", "status.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The id of target program.", "type": "text/plain" }, "type": "any", "value": "", "key": "programId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"statusName\": \"\",\n \"input\": [\n {\n \"leadId\": \"\"\n },\n {\n \"leadId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"status\": \"skipped\",\n \"leadId\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"status\": \"updated\",\n \"leadId\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Static Lists", "description": "Create and manage static lists and their membership.", "item": [ { "id": "c7d2ab7c-5dba-4ffa-aaa4-e0e13c0a4650", "name": "Get Leads By List Id", "request": { "name": "Get Leads By List Id", "description": { "content": "Retrieves person records which are members of the given static list. Required Permissions: Read-Only Lead, Read-Write Lead", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "list", ":listId", "leads.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Comma-separated list of lead fields to return for each record. If unset will return email, updatedAt, createdAt, lastName, firstName and id", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "{{nextPageToken}}" } ], "variable": [ { "type": "any", "value": "", "key": "listId", "disabled": false, "description": { "content": "(Required) Id of the static list to retrieve records from", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "717f68a5-93ba-4e3d-ba35-3410a827b23b", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "list", ":listId", "leads.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Comma-separated list of lead fields to return for each record. If unset will return email, updatedAt, createdAt, lastName, firstName and id", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the static list to retrieve records from", "type": "text/plain" }, "type": "any", "value": "", "key": "listId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"membership\": {\n \"membershipDate\": \"\",\n \"progressionStatus\": \"\",\n \"acquiredBy\": \"\",\n \"isExhausted\": \"\",\n \"nurtureCadence\": \"\",\n \"reachedSuccess\": \"\",\n \"stream\": \"\"\n },\n \"reason\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"status\": \"\"\n },\n {\n \"id\": \"\",\n \"membership\": {\n \"membershipDate\": \"\",\n \"progressionStatus\": \"\",\n \"acquiredBy\": \"\",\n \"isExhausted\": \"\",\n \"nurtureCadence\": \"\",\n \"reachedSuccess\": \"\",\n \"stream\": \"\"\n },\n \"reason\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"status\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "78e78660-fa61-41d7-a78d-6f1f3326ca27", "name": "Get Lists", "request": { "name": "Get Lists", "description": { "content": "Returns a set of static list records based on given filter parameters. Required Permissions: Read-Only Lead, Read-Write Lead", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "lists.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Comma-separated list of static list ids to return", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated list of static list names to return", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated list of program names. If set will return all static lists that are children of the given programs", "type": "text/plain" }, "key": "programName", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated list of workspace names. If set will return all static lists that are children of the given workspaces", "type": "text/plain" }, "key": "workspaceName", "value": "" }, { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "{{nextPageToken}}" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "bee905fe-f9d6-4150-9d39-c760ebcfdb4e", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "lists.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Comma-separated list of static list ids to return", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated list of static list names to return", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated list of program names. If set will return all static lists that are children of the given programs", "type": "text/plain" }, "key": "programName", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated list of workspace names. If set will return all static lists that are children of the given workspaces", "type": "text/plain" }, "key": "workspaceName", "value": "" }, { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"createdAt\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"description\": \"\",\n \"programName\": \"\",\n \"workspaceName\": \"\"\n },\n {\n \"createdAt\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"description\": \"\",\n \"programName\": \"\",\n \"workspaceName\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5806a7ce-0ff1-4538-8168-368a61555147", "name": "Get List by Id", "request": { "name": "Get List by Id", "description": { "content": "Returns a list record by its id. Required Permissions: Read-Only Lead, Read-Write Lead", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "lists", "{{listId}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "674252b0-a91c-4a74-9696-fc97012737b3", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "lists", "{{listId}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"createdAt\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"description\": \"\",\n \"programName\": \"\",\n \"workspaceName\": \"\"\n },\n {\n \"createdAt\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"description\": \"\",\n \"programName\": \"\",\n \"workspaceName\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4bfb4271-e9f5-4d5f-9d83-32337b8048df", "name": "Get Leads By List Id", "request": { "name": "Get Leads By List Id", "description": { "content": "Retrieves person records which are members of the given static list. Required Permissions: Read-Only Lead, Read-Write Lead", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "lists", ":listId", "leads.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Comma-separated list of lead fields to return for each record. If unset will return email, updatedAt, createdAt, lastName, firstName and id", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "{{nextPageToken}}" } ], "variable": [ { "type": "any", "value": "", "key": "listId", "disabled": false, "description": { "content": "(Required) Id of the static list to retrieve records from", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1057f7b8-7e7e-4ea8-8f11-676b41045863", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "lists", ":listId", "leads.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Comma-separated list of lead fields to return for each record. If unset will return email, updatedAt, createdAt, lastName, firstName and id", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the static list to retrieve records from", "type": "text/plain" }, "type": "any", "value": "", "key": "listId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"membership\": {\n \"membershipDate\": \"\",\n \"progressionStatus\": \"\",\n \"acquiredBy\": \"\",\n \"isExhausted\": \"\",\n \"nurtureCadence\": \"\",\n \"reachedSuccess\": \"\",\n \"stream\": \"\"\n },\n \"reason\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"status\": \"\"\n },\n {\n \"id\": \"\",\n \"membership\": {\n \"membershipDate\": \"\",\n \"progressionStatus\": \"\",\n \"acquiredBy\": \"\",\n \"isExhausted\": \"\",\n \"nurtureCadence\": \"\",\n \"reachedSuccess\": \"\",\n \"stream\": \"\"\n },\n \"reason\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"status\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "874afd38-40cf-4f51-a4cc-accb0ba31c95", "name": "Add to List", "request": { "name": "Add to List", "description": { "content": "Adds 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", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "lists", ":listId", "leads.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Comma-separated list of lead ids to add to the list", "type": "text/plain" }, "key": "id", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "listId", "disabled": false, "description": { "content": "(Required) Id of target list", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c141b897-b5bd-42f3-96a6-2f4a88bd282e", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "lists", ":listId", "leads.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Comma-separated list of lead ids to add to the list", "type": "text/plain" }, "key": "id", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of target list", "type": "text/plain" }, "type": "any", "value": "", "key": "listId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"\"\n },\n {\n \"id\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "05633adf-3d04-4d4b-a0c7-c3e07af25c15", "name": "Remove from List", "request": { "name": "Remove from List", "description": { "content": "Removes a given set of person records from a target static list. Required Permissions: Read-Write Lead", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "lists", ":listId", "leads.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "key": "id", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "listId", "disabled": false, "description": { "content": "(Required) Id of static list to remove leads from", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "2dc54d6e-c5e6-4028-ab8c-237d942bae51", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "lists", ":listId", "leads.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "key": "id", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of static list to remove leads from", "type": "text/plain" }, "type": "any", "value": "", "key": "listId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"\"\n },\n {\n \"id\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1f24f1c5-4b18-4998-af3a-1c19ba1b4a93", "name": "Member of List", "request": { "name": "Member of List", "description": { "content": "Checks if leads are members of a given static list. Required Permissions: Read-Write Lead", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "lists", ":listId", "leads", "ismember.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Comma-separated list of lead ids to check", "type": "text/plain" }, "key": "id", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "listId", "disabled": false, "description": { "content": "(Required) Id of the static list to check against", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c104665b-fc0f-4728-bd31-cbcb0242ad92", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "lists", ":listId", "leads", "ismember.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Comma-separated list of lead ids to check", "type": "text/plain" }, "key": "id", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the static list to check against", "type": "text/plain" }, "type": "any", "value": "", "key": "listId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"\"\n },\n {\n \"id\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "551566a6-9df2-40ac-9bc1-390778e50bea", "name": "Get Static List by Name", "request": { "name": "Get Static List by Name", "description": { "content": "Retrieves a Static List record by its name. Required Permissions: Read-Asset or Read-Write Asset", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "staticList", "byName.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Name of static list to retrieve", "type": "text/plain" }, "key": "name", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "bd7fd247-bd53-4148-976c-a4476e60d656", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "staticList", "byName.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Name of static list to retrieve", "type": "text/plain" }, "key": "name", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"workspace\": \"\",\n \"computedUrl\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"workspace\": \"\",\n \"computedUrl\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "35d3f505-5f8b-4eb3-9ae8-9449f725dfb6", "name": "Get Static List by Id", "request": { "name": "Get Static List by Id", "description": { "content": "Retrieves a Static List record by its id. Required Permissions: Read-Asset or Read-Write Asset", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "staticList", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b2814307-f8b0-494a-86d2-2ed281a5f237", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "staticList", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"workspace\": \"\",\n \"computedUrl\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"workspace\": \"\",\n \"computedUrl\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0dad7636-3259-4495-b5f2-ced2238c35c0", "name": "Update Static List Metadata", "request": { "name": "Update Static List Metadata", "description": { "content": "Updates the metadata of a static list asset. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "staticList", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "Description of the static list", "type": "text/plain" }, "key": "description", "value": "" }, { "disabled": true, "description": { "content": "Name of the static list", "type": "text/plain" }, "key": "name", "value": "" } ] }, "auth": null }, "response": [ { "id": "79d76412-ef64-4c78-b9ba-59e21ba3a461", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "staticList", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "Description of the static list", "type": "text/plain" }, "key": "description", "value": "" }, { "disabled": true, "description": { "content": "Name of the static list", "type": "text/plain" }, "key": "name", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"workspace\": \"\",\n \"computedUrl\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"workspace\": \"\",\n \"computedUrl\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2d32a03d-546e-4980-b96f-6005697c073e", "name": "Delete Static List", "request": { "name": "Delete Static List", "description": { "content": "Deletes the designated Static List. Required Permissions: Read-Write Asset", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "staticList", ":id", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Id of the static list to delete", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "2cd703f3-656e-47ae-9d9b-f4990533834e", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "staticList", ":id", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the static list to delete", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2da33c69-fd03-43fd-a076-a9b214cbeded", "name": "Get Static Lists", "request": { "name": "Get Static Lists", "description": { "content": "Retrieves a list of Static List records. Required Permissions: Read-Asset or Read-Write Asset", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "staticLists.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "folder", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of static lists to return. Max 200, default 20.", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Exclude static lists prior to this date. Must be valid ISO-8601 string. See Datetime field type description.", "type": "text/plain" }, "key": "earliestUpdatedAt", "value": "" }, { "disabled": true, "description": { "content": "Exclude static lists after this date. Must be valid ISO-8601 string. See Datetime field type description.", "type": "text/plain" }, "key": "latestUpdatedAt", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "dcd6444e-bfad-4b6e-89e7-0232764735e2", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "staticLists.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "folder", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of static lists to return. Max 200, default 20.", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Exclude static lists prior to this date. Must be valid ISO-8601 string. See Datetime field type description.", "type": "text/plain" }, "key": "earliestUpdatedAt", "value": "" }, { "disabled": true, "description": { "content": "Exclude static lists after this date. Must be valid ISO-8601 string. See Datetime field type description.", "type": "text/plain" }, "key": "latestUpdatedAt", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"workspace\": \"\",\n \"computedUrl\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"workspace\": \"\",\n \"computedUrl\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1e97eab8-79ba-4dad-b84a-8cfa8160ddc8", "name": "Create Static List", "request": { "name": "Create Static List", "description": { "content": "Creates a new Static List. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "staticLists.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Name of the static list", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": false, "description": { "content": "(Required) Folder object describing the parent folder", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) Folder object describing the parent folder", "type": "text/plain" }, "key": "type", "value": "Program" }, { "disabled": true, "description": { "content": "Description of the static list", "type": "text/plain" }, "key": "description", "value": "" } ] }, "auth": null }, "response": [ { "id": "9b2b825a-e647-415f-9a17-791a81cd9282", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "staticLists.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Name of the static list", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": false, "description": { "content": "(Required) Folder object describing the parent folder", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) Folder object describing the parent folder", "type": "text/plain" }, "key": "type", "value": "Program" }, { "disabled": true, "description": { "content": "Description of the static list", "type": "text/plain" }, "key": "description", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"workspace\": \"\",\n \"computedUrl\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"workspace\": \"\",\n \"computedUrl\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Custom Objects", "description": "Describe custom objects and perform CRUD operations on their records.", "item": [ { "id": "3883de83-9e63-48e6-8c52-aa99cfb81b50", "name": "List Custom Objects", "request": { "name": "List Custom Objects", "description": { "content": "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", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "customobjects.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Comma-separated list of names to filter types on", "type": "text/plain" }, "key": "names", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "8005f5be-ee88-4a1f-8afb-69df7d5a6371", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "customobjects.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Comma-separated list of names to filter types on", "type": "text/plain" }, "key": "names", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"createdAt\": \"\",\n \"dedupeFields\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"displayName\": \"\",\n \"pluralName\": \"\",\n \"fields\": [\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"length\": \"\",\n \"name\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\"\n },\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"length\": \"\",\n \"name\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\"\n }\n ],\n \"idField\": \"\",\n \"apiName\": \"\",\n \"relationships\": [\n {\n \"field\": \"\",\n \"relatedTo\": {\n \"field\": \"\",\n \"name\": \"\"\n },\n \"type\": \"\"\n },\n {\n \"field\": \"\",\n \"relatedTo\": {\n \"field\": \"\",\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n ],\n \"searchableFields\": [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ],\n \"updatedAt\": \"\",\n \"state\": \"draft\",\n \"version\": \"draft\"\n },\n {\n \"createdAt\": \"\",\n \"dedupeFields\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"displayName\": \"\",\n \"pluralName\": \"\",\n \"fields\": [\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"length\": \"\",\n \"name\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\"\n },\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"length\": \"\",\n \"name\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\"\n }\n ],\n \"idField\": \"\",\n \"apiName\": \"\",\n \"relationships\": [\n {\n \"field\": \"\",\n \"relatedTo\": {\n \"field\": \"\",\n \"name\": \"\"\n },\n \"type\": \"\"\n },\n {\n \"field\": \"\",\n \"relatedTo\": {\n \"field\": \"\",\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n ],\n \"searchableFields\": [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ],\n \"updatedAt\": \"\",\n \"state\": \"draft\",\n \"version\": \"draft\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "adb8cf7d-450e-45a7-9455-1a1dad12400b", "name": "List Custom Object Types", "request": { "name": "List Custom Object Types", "description": { "content": "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", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "customobjects", "schema.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Comma-separated list of API names of custom object types to filter on", "type": "text/plain" }, "key": "names", "value": "" }, { "disabled": true, "description": { "content": "State of custom object type to filter on. By default, if an approved version exists, it is returned. Otherwise, the draft version is returned. (This can only be one of draft,approved,approvedWithDraft)", "type": "text/plain" }, "key": "state", "value": "approvedWithDraft" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9a5a189c-16fb-4738-aedb-b6b70f577caf", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "customobjects", "schema.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Comma-separated list of API names of custom object types to filter on", "type": "text/plain" }, "key": "names", "value": "" }, { "disabled": true, "description": { "content": "State of custom object type to filter on. By default, if an approved version exists, it is returned. Otherwise, the draft version is returned. (This can only be one of draft,approved,approvedWithDraft)", "type": "text/plain" }, "key": "state", "value": "approvedWithDraft" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"createdAt\": \"\",\n \"dedupeFields\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"displayName\": \"\",\n \"pluralName\": \"\",\n \"fields\": [\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"length\": \"\",\n \"name\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\"\n },\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"length\": \"\",\n \"name\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\"\n }\n ],\n \"idField\": \"\",\n \"apiName\": \"\",\n \"relationships\": [\n {\n \"field\": \"\",\n \"relatedTo\": {\n \"field\": \"\",\n \"name\": \"\"\n },\n \"type\": \"\"\n },\n {\n \"field\": \"\",\n \"relatedTo\": {\n \"field\": \"\",\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n ],\n \"searchableFields\": [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ],\n \"updatedAt\": \"\",\n \"state\": \"draft\",\n \"version\": \"draft\"\n },\n {\n \"createdAt\": \"\",\n \"dedupeFields\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"displayName\": \"\",\n \"pluralName\": \"\",\n \"fields\": [\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"length\": \"\",\n \"name\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\"\n },\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"length\": \"\",\n \"name\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\"\n }\n ],\n \"idField\": \"\",\n \"apiName\": \"\",\n \"relationships\": [\n {\n \"field\": \"\",\n \"relatedTo\": {\n \"field\": \"\",\n \"name\": \"\"\n },\n \"type\": \"\"\n },\n {\n \"field\": \"\",\n \"relatedTo\": {\n \"field\": \"\",\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n ],\n \"searchableFields\": [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ],\n \"updatedAt\": \"\",\n \"state\": \"draft\",\n \"version\": \"draft\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "87204f9f-8b2a-4d4e-af30-aa1b24372a5d", "name": "Sync Custom Object Type", "request": { "name": "Sync Custom Object Type", "description": { "content": "Inserts, updates, or upserts custom object type record to the target instance. Required Permissions: Read-Write Custom Object Type", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "customobjects", "schema.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apiName\": \"\",\n \"displayName\": \"\",\n \"action\": \"updateOnly\",\n \"pluralName\": \"\",\n \"description\": \"\",\n \"showInLeadDetail\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "b81c314c-ced4-461b-8d08-67800af13c49", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "customobjects", "schema.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apiName\": \"\",\n \"displayName\": \"\",\n \"action\": \"updateOnly\",\n \"pluralName\": \"\",\n \"description\": \"\",\n \"showInLeadDetail\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n \"\",\n \"\"\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "496a6616-e006-4904-8d6c-275698e213c1", "name": "Get Custom Object Type Field Data Types", "request": { "name": "Get Custom Object Type Field Data Types", "description": { "content": "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", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "customobjects", "schema", "fieldDataTypes.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e4dead18-fa69-46c0-9df2-167b14f6483f", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "customobjects", "schema", "fieldDataTypes.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n \"\",\n \"\"\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "395711cb-3837-45b1-ac75-642ec518541b", "name": "Get Custom Object Linkable Objects", "request": { "name": "Get Custom Object Linkable Objects", "description": { "content": "Returns a list of linkable custom objects and their fields. Required Permissions: Read-Only Custom Object Type, Read-Write Custom Object Type", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "customobjects", "schema", "linkableObjects.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a03dfd03-6680-45bf-8293-15e8bfb92411", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "customobjects", "schema", "linkableObjects.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"fields\": [\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"dataType\": \"\"\n },\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"dataType\": \"\"\n }\n ]\n },\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"fields\": [\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"dataType\": \"\"\n },\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"dataType\": \"\"\n }\n ]\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "66795a67-4cab-4d40-8be3-ecc64703f1fa", "name": "Add Custom Object Type Fields", "request": { "name": "Add Custom Object Type Fields", "description": { "content": "Adds fields to custom object type. Required Permissions: Read-Write Custom Object Type", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "customobjects", "schema", ":apiName", "addField.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "apiName", "disabled": false, "description": { "content": "(Required) API name of custom object type", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"dataType\": \"\",\n \"description\": \"\",\n \"isDedupeField\": \"\",\n \"relatedTo\": {\n \"name\": \"\",\n \"field\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"dataType\": \"\",\n \"description\": \"\",\n \"isDedupeField\": \"\",\n \"relatedTo\": {\n \"name\": \"\",\n \"field\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f07a9835-32e3-48cf-a3a9-c32b1610edcb", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "customobjects", "schema", ":apiName", "addField.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) API name of custom object type", "type": "text/plain" }, "type": "any", "value": "", "key": "apiName" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"dataType\": \"\",\n \"description\": \"\",\n \"isDedupeField\": \"\",\n \"relatedTo\": {\n \"name\": \"\",\n \"field\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"dataType\": \"\",\n \"description\": \"\",\n \"isDedupeField\": \"\",\n \"relatedTo\": {\n \"name\": \"\",\n \"field\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n \"\",\n \"\"\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d4a4dcd5-af7f-417f-8003-f0e011451e3c", "name": "Approve Custom Object Type", "request": { "name": "Approve Custom Object Type", "description": { "content": "Approves 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", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "customobjects", "schema", ":apiName", "approve.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "apiName", "disabled": false, "description": { "content": "(Required) API Name of the custom object type to approve", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "a32a4233-c88d-4bd3-8593-a7fa207c28da", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "customobjects", "schema", ":apiName", "approve.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) API Name of the custom object type to approve", "type": "text/plain" }, "type": "any", "value": "", "key": "apiName" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n \"\",\n \"\"\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "55022f4c-6dd4-4bfb-a820-dce246a48b4c", "name": "Delete Custom Object Type", "request": { "name": "Delete Custom Object Type", "description": { "content": "Deletes 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", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "customobjects", "schema", ":apiName", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "apiName", "disabled": false, "description": { "content": "(Required) API Name of the custom object type to delete", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "917957ca-61b1-4693-b79b-984fffd18f5f", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "customobjects", "schema", ":apiName", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) API Name of the custom object type to delete", "type": "text/plain" }, "type": "any", "value": "", "key": "apiName" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n \"\",\n \"\"\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2158c52f-8177-4dbc-ab6d-deecb3758413", "name": "Delete Custom Object Type Fields", "request": { "name": "Delete Custom Object Type Fields", "description": { "content": "Deletes fields from custom object type. Required Permissions: Read-Write Custom Object Type", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "customobjects", "schema", ":apiName", "deleteField.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "apiName", "disabled": false, "description": { "content": "(Required) API name of custom object type", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"name\": \"\"\n },\n {\n \"name\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d8d0917a-e570-4ec5-88e9-cbf805695a18", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "customobjects", "schema", ":apiName", "deleteField.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) API name of custom object type", "type": "text/plain" }, "type": "any", "value": "", "key": "apiName" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"name\": \"\"\n },\n {\n \"name\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n \"\",\n \"\"\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5116fbbe-c042-4eb0-89e3-af56abda8ef9", "name": "Get Custom Object Dependent Assets", "request": { "name": "Get Custom Object Dependent Assets", "description": { "content": "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", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "customobjects", "schema", ":apiName", "dependentAssets.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "apiName", "disabled": false, "description": { "content": "(Required) REST API name for custom object", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ff83789c-02eb-4b33-80d9-002258b0beb9", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "customobjects", "schema", ":apiName", "dependentAssets.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) REST API name for custom object", "type": "text/plain" }, "type": "any", "value": "", "key": "apiName" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"assetType\": \"\",\n \"assetId\": \"\",\n \"assetName\": \"\",\n \"usedFields\": [\n \"\",\n \"\"\n ]\n },\n {\n \"assetType\": \"\",\n \"assetId\": \"\",\n \"assetName\": \"\",\n \"usedFields\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "df735dae-7f58-44d0-901c-a77177c98f58", "name": "Describe Custom Object Type", "request": { "name": "Describe Custom Object Type", "description": { "content": "Returns metadata regarding a given custom object type (including relationships and fields). Required Permissions: Read-Only Custom Object Type, Read-Write Custom Object Type", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "customobjects", "schema", ":apiName", "describe.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "State of custom object type to filter on. By default, if an approved version exists, it is returned. Otherwise, the draft version is returned. (This can only be one of draft,approved,approvedWithDraft)", "type": "text/plain" }, "key": "state", "value": "approvedWithDraft" } ], "variable": [ { "type": "any", "value": "", "key": "apiName", "disabled": false, "description": { "content": "(Required) API name of custom object type to describe", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "55c4d06f-8e5f-4534-b331-9f33f1a775e0", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "customobjects", "schema", ":apiName", "describe.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "State of custom object type to filter on. By default, if an approved version exists, it is returned. Otherwise, the draft version is returned. (This can only be one of draft,approved,approvedWithDraft)", "type": "text/plain" }, "key": "state", "value": "approvedWithDraft" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) API name of custom object type to describe", "type": "text/plain" }, "type": "any", "value": "", "key": "apiName" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"createdAt\": \"\",\n \"dedupeFields\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"displayName\": \"\",\n \"pluralName\": \"\",\n \"fields\": [\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"length\": \"\",\n \"name\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\"\n },\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"length\": \"\",\n \"name\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\"\n }\n ],\n \"idField\": \"\",\n \"apiName\": \"\",\n \"relationships\": [\n {\n \"field\": \"\",\n \"relatedTo\": {\n \"field\": \"\",\n \"name\": \"\"\n },\n \"type\": \"\"\n },\n {\n \"field\": \"\",\n \"relatedTo\": {\n \"field\": \"\",\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n ],\n \"searchableFields\": [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ],\n \"updatedAt\": \"\",\n \"state\": \"draft\",\n \"version\": \"draft\"\n },\n {\n \"createdAt\": \"\",\n \"dedupeFields\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"displayName\": \"\",\n \"pluralName\": \"\",\n \"fields\": [\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"length\": \"\",\n \"name\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\"\n },\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"length\": \"\",\n \"name\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\"\n }\n ],\n \"idField\": \"\",\n \"apiName\": \"\",\n \"relationships\": [\n {\n \"field\": \"\",\n \"relatedTo\": {\n \"field\": \"\",\n \"name\": \"\"\n },\n \"type\": \"\"\n },\n {\n \"field\": \"\",\n \"relatedTo\": {\n \"field\": \"\",\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n ],\n \"searchableFields\": [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ],\n \"updatedAt\": \"\",\n \"state\": \"draft\",\n \"version\": \"draft\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "51a0119a-98ea-4607-a34d-3c960392247d", "name": "Discard Custom Object Type Draft", "request": { "name": "Discard Custom Object Type Draft", "description": { "content": "Discards the current draft of the custom object type. Required Permissions: Read-Write Custom Object Type", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "customobjects", "schema", ":apiName", "discardDraft.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "apiName", "disabled": false, "description": { "content": "(Required) API Name of the custom object type draft to discard", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "02042470-d65c-4264-bd6c-765d813a8d84", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "customobjects", "schema", ":apiName", "discardDraft.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) API Name of the custom object type draft to discard", "type": "text/plain" }, "type": "any", "value": "", "key": "apiName" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n \"\",\n \"\"\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a31c191d-384a-4282-87f8-22be8587683e", "name": "Update Custom Object Type Field", "request": { "name": "Update Custom Object Type Field", "description": { "content": "Updates a field in custom object type. Required Permissions: Read-Write Custom Object Type", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "customobjects", "schema", ":apiName", ":fieldApiName", "updateField.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "apiName", "disabled": false, "description": { "content": "(Required) API name of custom object type", "type": "text/plain" } }, { "type": "any", "value": "", "key": "fieldApiName", "disabled": false, "description": { "content": "(Required) API name of custom object type field", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"displayName\": \"\",\n \"dataType\": \"\",\n \"description\": \"\",\n \"isDedupeField\": \"\",\n \"relatedTo\": {\n \"name\": \"\",\n \"field\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "65e5f8a3-dde0-4506-8c84-ee10a7d0fb58", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "customobjects", "schema", ":apiName", ":fieldApiName", "updateField.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) API name of custom object type", "type": "text/plain" }, "type": "any", "value": "", "key": "apiName" }, { "disabled": false, "description": { "content": "(Required) API name of custom object type field", "type": "text/plain" }, "type": "any", "value": "", "key": "fieldApiName" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"displayName\": \"\",\n \"dataType\": \"\",\n \"description\": \"\",\n \"isDedupeField\": \"\",\n \"relatedTo\": {\n \"name\": \"\",\n \"field\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n \"\",\n \"\"\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "83a7a465-4eeb-4bad-a9b6-e5a7112f39b0", "name": "Get Custom Objects", "request": { "name": "Get Custom Objects", "description": { "content": "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", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "customobjects", "{{customObjectName}}.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Field to filter on. Searchable fields can be retrieved with Describe Custom Object", "type": "text/plain" }, "key": "filterType", "value": "" }, { "disabled": false, "description": { "content": "(Required) Comma-separated list of field values to match against.", "type": "text/plain" }, "key": "filterValues", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated list of fields to return for each record. If unset marketoGuid, dedupeFields, updatedAt, createdAt will be returned", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "{{nextPageToken}}" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ],\n \"batchSize\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"filterType\": \"\",\n \"nextPageToken\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "b6dfa793-cf46-42a3-92de-2bb008e55222", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "customobjects", "{{customObjectName}}.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Field to filter on. Searchable fields can be retrieved with Describe Custom Object", "type": "text/plain" }, "key": "filterType", "value": "" }, { "disabled": false, "description": { "content": "(Required) Comma-separated list of field values to match against.", "type": "text/plain" }, "key": "filterValues", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated list of fields to return for each record. If unset marketoGuid, dedupeFields, updatedAt, createdAt will be returned", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ],\n \"batchSize\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"filterType\": \"\",\n \"nextPageToken\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8e593a7f-d4b9-4bc5-9575-d8aaf03b271c", "name": "Sync Custom Objects", "request": { "name": "Sync Custom Objects", "description": { "content": "Inserts, updates, or upserts custom object records to the target instance. Required Permissions: Read-Write Custom Object", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "customobjects", "{{customObjectName}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ],\n \"action\": \"createOnly\",\n \"dedupeBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "97e78f78-36a1-4b27-8b7c-cf71ba2e9b16", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "customobjects", "{{customObjectName}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ],\n \"action\": \"createOnly\",\n \"dedupeBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b3a24521-db6d-4312-9981-e8b2a3ff0241", "name": "Delete Custom Objects", "request": { "name": "Delete Custom Objects", "description": { "content": "Deletes a given set of custom object records. Required Permissions: Read-Write Custom Object", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "customobjects", ":customObjectName", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customObjectName", "disabled": false, "description": { "content": "(Required) customObjectName", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ],\n \"deleteBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "6b3739da-f139-44f7-9cc9-5c439944fdc1", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "customobjects", ":customObjectName", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) customObjectName", "type": "text/plain" }, "type": "any", "value": "", "key": "customObjectName" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ],\n \"deleteBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9cae8647-659b-42df-aef0-db3c5115e4bb", "name": "Describe Custom Objects", "request": { "name": "Describe Custom Objects", "description": { "content": "Returns metadata regarding a given custom object. Required Permissions: Read-Only Custom Object, Read-Write Custom Object", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "customobjects", ":customObjectName", "describe.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customObjectName", "disabled": false, "description": { "content": "(Required) customObjectName", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "8b791d47-87d2-49b7-820e-3a5d75b90abc", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "customobjects", ":customObjectName", "describe.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) customObjectName", "type": "text/plain" }, "type": "any", "value": "", "key": "customObjectName" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"createdAt\": \"\",\n \"dedupeFields\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"displayName\": \"\",\n \"pluralName\": \"\",\n \"fields\": [\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"length\": \"\",\n \"name\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\"\n },\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"length\": \"\",\n \"name\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\"\n }\n ],\n \"idField\": \"\",\n \"apiName\": \"\",\n \"relationships\": [\n {\n \"field\": \"\",\n \"relatedTo\": {\n \"field\": \"\",\n \"name\": \"\"\n },\n \"type\": \"\"\n },\n {\n \"field\": \"\",\n \"relatedTo\": {\n \"field\": \"\",\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n ],\n \"searchableFields\": [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ],\n \"updatedAt\": \"\",\n \"state\": \"draft\",\n \"version\": \"draft\"\n },\n {\n \"createdAt\": \"\",\n \"dedupeFields\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"displayName\": \"\",\n \"pluralName\": \"\",\n \"fields\": [\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"length\": \"\",\n \"name\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\"\n },\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"length\": \"\",\n \"name\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\"\n }\n ],\n \"idField\": \"\",\n \"apiName\": \"\",\n \"relationships\": [\n {\n \"field\": \"\",\n \"relatedTo\": {\n \"field\": \"\",\n \"name\": \"\"\n },\n \"type\": \"\"\n },\n {\n \"field\": \"\",\n \"relatedTo\": {\n \"field\": \"\",\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n ],\n \"searchableFields\": [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ],\n \"updatedAt\": \"\",\n \"state\": \"draft\",\n \"version\": \"draft\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Companies", "description": "CRUD operations on Company records, the standard Marketo company object.", "item": [ { "id": "344ff396-652c-4174-8d9c-1f767b7dc232", "name": "Get Companies", "request": { "name": "Get Companies", "description": { "content": "Retrieves company records from the destination instance based on the submitted filter. Required Permissions: Read-Only Company, Read-Write Company", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "companies.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The company field to filter on. Searchable fields can be retrieved with the Describe Company call.", "type": "text/plain" }, "key": "filterType", "value": "" }, { "disabled": false, "description": { "content": "(Required) Comma-separated list of values to match against", "type": "text/plain" }, "key": "filterValues", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated list of fields to include in the response", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "{{nextPageToken}}" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "85f399a3-a981-4afb-bbc5-f22a188efb11", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "companies.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The company field to filter on. Searchable fields can be retrieved with the Describe Company call.", "type": "text/plain" }, "key": "filterType", "value": "" }, { "disabled": false, "description": { "content": "(Required) Comma-separated list of values to match against", "type": "text/plain" }, "key": "filterValues", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated list of fields to include in the response", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"added\"\n },\n {\n \"id\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"added\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "359de79f-d0ec-4a41-96e2-93c6835227a6", "name": "Sync Companies", "request": { "name": "Sync Companies", "description": { "content": "Allows inserting, updating, or upserting of company records into Marketo. Required Permissions: Read-Write Company", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "companies.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"externalCompanyId\": \"\",\n \"id\": \"\",\n \"company\": \"\"\n },\n {\n \"externalCompanyId\": \"\",\n \"id\": \"\",\n \"company\": \"\"\n }\n ],\n \"action\": \"updateOnly\",\n \"dedupeBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7767e2f1-035e-4d78-af24-a72485c92f0e", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "companies.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"externalCompanyId\": \"\",\n \"id\": \"\",\n \"company\": \"\"\n },\n {\n \"externalCompanyId\": \"\",\n \"id\": \"\",\n \"company\": \"\"\n }\n ],\n \"action\": \"updateOnly\",\n \"dedupeBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"added\"\n },\n {\n \"id\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"added\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "52f88fd4-b0cf-4114-8a6c-26c614d1b07d", "name": "Delete Companies", "request": { "name": "Delete Companies", "description": { "content": "Deletes the included list of company records from the destination instance. Required Permissions: Read-Write Company", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "companies", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"deleteBy\": \"\",\n \"input\": [\n {\n \"externalCompanyId\": \"\",\n \"id\": \"\",\n \"company\": \"\"\n },\n {\n \"externalCompanyId\": \"\",\n \"id\": \"\",\n \"company\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ad59dcdf-b8b7-40a2-b5cc-ce9732488a8b", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "companies", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"deleteBy\": \"\",\n \"input\": [\n {\n \"externalCompanyId\": \"\",\n \"id\": \"\",\n \"company\": \"\"\n },\n {\n \"externalCompanyId\": \"\",\n \"id\": \"\",\n \"company\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"added\"\n },\n {\n \"id\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"added\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0f186797-30cb-4159-98e4-403fc8614882", "name": "Describe Companies", "request": { "name": "Describe Companies", "description": { "content": "Returns metadata about companies and the fields available for interaction via the API. Required Permissions: Read-Only Company, Read-Write Company", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "companies", "describe.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ea2bd275-a2c1-4ab2-b45c-71f876c6fd05", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "companies", "describe.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"createdAt\": \"\",\n \"dedupeFields\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"displayName\": \"\",\n \"pluralName\": \"\",\n \"fields\": [\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"length\": \"\",\n \"name\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\"\n },\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"length\": \"\",\n \"name\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\"\n }\n ],\n \"idField\": \"\",\n \"apiName\": \"\",\n \"relationships\": [\n {\n \"field\": \"\",\n \"relatedTo\": {\n \"field\": \"\",\n \"name\": \"\"\n },\n \"type\": \"\"\n },\n {\n \"field\": \"\",\n \"relatedTo\": {\n \"field\": \"\",\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n ],\n \"searchableFields\": [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ],\n \"updatedAt\": \"\",\n \"state\": \"draft\",\n \"version\": \"draft\"\n },\n {\n \"createdAt\": \"\",\n \"dedupeFields\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"displayName\": \"\",\n \"pluralName\": \"\",\n \"fields\": [\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"length\": \"\",\n \"name\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\"\n },\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"length\": \"\",\n \"name\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\"\n }\n ],\n \"idField\": \"\",\n \"apiName\": \"\",\n \"relationships\": [\n {\n \"field\": \"\",\n \"relatedTo\": {\n \"field\": \"\",\n \"name\": \"\"\n },\n \"type\": \"\"\n },\n {\n \"field\": \"\",\n \"relatedTo\": {\n \"field\": \"\",\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n ],\n \"searchableFields\": [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ],\n \"updatedAt\": \"\",\n \"state\": \"draft\",\n \"version\": \"draft\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "156f915e-5a94-42e1-82e0-20f4cb637274", "name": "Get Company Fields", "request": { "name": "Get Company Fields", "description": { "content": "Retrieves metadata for all company fields in the target instance. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "companies", "schema", "fields.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "{{nextPageToken}}" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2a6448d9-b38c-46b0-821b-5c09e71b54d4", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "companies", "schema", "fields.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"displayName\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"dataType\": \"\",\n \"isHidden\": \"\",\n \"isHtmlEncodingInEmail\": \"\",\n \"isSensitive\": \"\",\n \"isCustom\": \"\",\n \"isApiCreated\": \"\",\n \"length\": \"\"\n },\n {\n \"displayName\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"dataType\": \"\",\n \"isHidden\": \"\",\n \"isHtmlEncodingInEmail\": \"\",\n \"isSensitive\": \"\",\n \"isCustom\": \"\",\n \"isApiCreated\": \"\",\n \"length\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9a28d9f3-b01b-44e2-bc95-e0bdc41b54fe", "name": "Get Company Field by Name", "request": { "name": "Get Company Field by Name", "description": { "content": "Retrieves metadata for single company field. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "companies", "schema", "fields", "{{fieldApiName}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "20572566-a5a4-467e-bd5a-458e77023743", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "companies", "schema", "fields", "{{fieldApiName}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"displayName\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"dataType\": \"\",\n \"isHidden\": \"\",\n \"isHtmlEncodingInEmail\": \"\",\n \"isSensitive\": \"\",\n \"isCustom\": \"\",\n \"isApiCreated\": \"\",\n \"length\": \"\"\n },\n {\n \"displayName\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"dataType\": \"\",\n \"isHidden\": \"\",\n \"isHtmlEncodingInEmail\": \"\",\n \"isSensitive\": \"\",\n \"isCustom\": \"\",\n \"isApiCreated\": \"\",\n \"length\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Opportunities", "description": "Describe and perform CRUD operations on Opportunity and Opportunity Role records.", "item": [ { "id": "79bb9442-2660-4f47-a4d5-2551e7d81eba", "name": "Get Opportunities", "request": { "name": "Get Opportunities", "description": { "content": "Returns a list of opportunities based on a filter and set of values. Required Permissions: Read-Only Opportunity, Read-Write Named Opportunity", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "opportunities.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Opportunities field to filter on", "type": "text/plain" }, "key": "filterType", "value": "" }, { "disabled": false, "description": { "content": "(Required) Comma-separated list of values to match against", "type": "text/plain" }, "key": "filterValues", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated list of fields to include in the response", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of records to return in the response. Max and default is 300", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "Paging token returned from a previous response", "type": "text/plain" }, "key": "nextPageToken", "value": "{{nextPageToken}}" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ],\n \"batchSize\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"filterType\": \"\",\n \"nextPageToken\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "38662281-fb69-4f80-8d0b-c9b2813d1e7d", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "opportunities.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Opportunities field to filter on", "type": "text/plain" }, "key": "filterType", "value": "" }, { "disabled": false, "description": { "content": "(Required) Comma-separated list of values to match against", "type": "text/plain" }, "key": "filterValues", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated list of fields to include in the response", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of records to return in the response. Max and default is 300", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "Paging token returned from a previous response", "type": "text/plain" }, "key": "nextPageToken", "value": "" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ],\n \"batchSize\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"filterType\": \"\",\n \"nextPageToken\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2d5bf6d4-09e5-4d3b-849f-a672a7fb2461", "name": "Sync Opportunities", "request": { "name": "Sync Opportunities", "description": { "content": "Allows inserting, updating, or upserting of opportunity records into the target instance. Required Permissions: Read-Write Named Opportunity", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "opportunities.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ],\n \"action\": \"createOnly\",\n \"dedupeBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "297f047a-2cfc-406d-8e55-94bb45ad2e3b", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "opportunities.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ],\n \"action\": \"createOnly\",\n \"dedupeBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b1fbe8c8-44dc-4a4c-b18c-1538a5764d84", "name": "Delete Opportunities", "request": { "name": "Delete Opportunities", "description": { "content": "Deletes 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", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "opportunities", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ],\n \"deleteBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "0f14d2ef-f854-41f5-a762-d4714ec4d2f5", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "opportunities", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ],\n \"deleteBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "27543a9e-e801-47dd-8f4a-e04e8f92b256", "name": "Describe Opportunity", "request": { "name": "Describe Opportunity", "description": { "content": "Returns object and field metadata for Opportunity type records in the target instance. Required Permissions: Read-Only Opportunity, Read-Write Named Opportunity", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "opportunities", "describe.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "71624dd6-0c43-40bf-8ae4-7e06d73537d7", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "opportunities", "describe.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"createdAt\": \"\",\n \"dedupeFields\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"displayName\": \"\",\n \"pluralName\": \"\",\n \"fields\": [\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"length\": \"\",\n \"name\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\"\n },\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"length\": \"\",\n \"name\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\"\n }\n ],\n \"idField\": \"\",\n \"apiName\": \"\",\n \"relationships\": [\n {\n \"field\": \"\",\n \"relatedTo\": {\n \"field\": \"\",\n \"name\": \"\"\n },\n \"type\": \"\"\n },\n {\n \"field\": \"\",\n \"relatedTo\": {\n \"field\": \"\",\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n ],\n \"searchableFields\": [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ],\n \"updatedAt\": \"\",\n \"state\": \"draft\",\n \"version\": \"draft\"\n },\n {\n \"createdAt\": \"\",\n \"dedupeFields\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"displayName\": \"\",\n \"pluralName\": \"\",\n \"fields\": [\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"length\": \"\",\n \"name\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\"\n },\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"length\": \"\",\n \"name\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\"\n }\n ],\n \"idField\": \"\",\n \"apiName\": \"\",\n \"relationships\": [\n {\n \"field\": \"\",\n \"relatedTo\": {\n \"field\": \"\",\n \"name\": \"\"\n },\n \"type\": \"\"\n },\n {\n \"field\": \"\",\n \"relatedTo\": {\n \"field\": \"\",\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n ],\n \"searchableFields\": [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ],\n \"updatedAt\": \"\",\n \"state\": \"draft\",\n \"version\": \"draft\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a15f6f3b-663e-4ed2-ab61-d2307da776b9", "name": "Get Opportunity Roles", "request": { "name": "Get Opportunity Roles", "description": { "content": "Returns a list of opportunity roles based on a filter and set of values. Required Permissions: Read-Only Opportunity, Read-Write Named Opportunity", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "opportunities", "roles.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The role field to filter on. Searchable fields can be retrieved with the Describe Opportunity call.", "type": "text/plain" }, "key": "filterType", "value": "" }, { "disabled": false, "description": { "content": "(Required) Comma-separated list of field values to return records for", "type": "text/plain" }, "key": "filterValues", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated list of fields to include in the response", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of records to return in the response. Max and default is 300", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "Paging token returned from a previous response", "type": "text/plain" }, "key": "nextPageToken", "value": "{{nextPageToken}}" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ],\n \"batchSize\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"filterType\": \"\",\n \"nextPageToken\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c45b3f7b-81d4-4422-b379-97bf5a332d90", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "opportunities", "roles.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The role field to filter on. Searchable fields can be retrieved with the Describe Opportunity call.", "type": "text/plain" }, "key": "filterType", "value": "" }, { "disabled": false, "description": { "content": "(Required) Comma-separated list of field values to return records for", "type": "text/plain" }, "key": "filterValues", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated list of fields to include in the response", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of records to return in the response. Max and default is 300", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "Paging token returned from a previous response", "type": "text/plain" }, "key": "nextPageToken", "value": "" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ],\n \"batchSize\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"filterType\": \"\",\n \"nextPageToken\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "07a092c0-5ac2-421e-b1cf-4ce9c525d3df", "name": "Sync Opportunity Roles", "request": { "name": "Sync Opportunity Roles", "description": { "content": "Allows inserts, updates and upserts of Opportunity Role records in the target instance. Required Permissions: Read-Write Named Opportunity", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "opportunities", "roles.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ],\n \"action\": \"createOnly\",\n \"dedupeBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "1bc2c8a2-3412-4d50-84dc-3e8e11b28aad", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "opportunities", "roles.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ],\n \"action\": \"createOnly\",\n \"dedupeBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e33ad414-95bb-47b8-9f11-6a16608f7e1c", "name": "Delete Opportunity Roles", "request": { "name": "Delete Opportunity Roles", "description": { "content": "Deletes a list of opportunities from the target instance. Required Permissions: Read-Write Named Opportunity", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "opportunities", "roles", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ],\n \"deleteBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "03d8d641-4f06-42af-9f0e-a2688e4d142f", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "opportunities", "roles", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ],\n \"deleteBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2910cd3b-d226-4880-ac91-084c872ab484", "name": "Describe Opportunity Role", "request": { "name": "Describe Opportunity Role", "description": { "content": "Returns object and field metadata for Opportunity Roles in the target instance. Required Permissions: Read-Only Opportunity, Read-Write Named Opportunity", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "opportunities", "roles", "describe.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "afc2ab9b-9aa3-4022-a9af-2be4c9be0742", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "opportunities", "roles", "describe.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"createdAt\": \"\",\n \"dedupeFields\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"displayName\": \"\",\n \"pluralName\": \"\",\n \"fields\": [\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"length\": \"\",\n \"name\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\"\n },\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"length\": \"\",\n \"name\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\"\n }\n ],\n \"idField\": \"\",\n \"apiName\": \"\",\n \"relationships\": [\n {\n \"field\": \"\",\n \"relatedTo\": {\n \"field\": \"\",\n \"name\": \"\"\n },\n \"type\": \"\"\n },\n {\n \"field\": \"\",\n \"relatedTo\": {\n \"field\": \"\",\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n ],\n \"searchableFields\": [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ],\n \"updatedAt\": \"\",\n \"state\": \"draft\",\n \"version\": \"draft\"\n },\n {\n \"createdAt\": \"\",\n \"dedupeFields\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"displayName\": \"\",\n \"pluralName\": \"\",\n \"fields\": [\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"length\": \"\",\n \"name\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\"\n },\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"length\": \"\",\n \"name\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\"\n }\n ],\n \"idField\": \"\",\n \"apiName\": \"\",\n \"relationships\": [\n {\n \"field\": \"\",\n \"relatedTo\": {\n \"field\": \"\",\n \"name\": \"\"\n },\n \"type\": \"\"\n },\n {\n \"field\": \"\",\n \"relatedTo\": {\n \"field\": \"\",\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n ],\n \"searchableFields\": [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ],\n \"updatedAt\": \"\",\n \"state\": \"draft\",\n \"version\": \"draft\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b8da1992-e130-469d-a6d7-ac37d2d9a7f1", "name": "Get Opportunity Fields", "request": { "name": "Get Opportunity Fields", "description": { "content": "Retrieves metadata for all opportunity fields in the target instance. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "opportunities", "schema", "fields.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "{{nextPageToken}}" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "dfb9ba6a-01bd-4117-8d7e-33cc0a0f152c", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "opportunities", "schema", "fields.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"displayName\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"dataType\": \"\",\n \"isHidden\": \"\",\n \"isHtmlEncodingInEmail\": \"\",\n \"isSensitive\": \"\",\n \"isCustom\": \"\",\n \"isApiCreated\": \"\",\n \"length\": \"\"\n },\n {\n \"displayName\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"dataType\": \"\",\n \"isHidden\": \"\",\n \"isHtmlEncodingInEmail\": \"\",\n \"isSensitive\": \"\",\n \"isCustom\": \"\",\n \"isApiCreated\": \"\",\n \"length\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "03bf2b19-d8d3-48ea-abe9-6aab3c0310a1", "name": "Get Opportunity Field by Name", "request": { "name": "Get Opportunity Field by Name", "description": { "content": "Retrieves metadata for single opportunity field. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "opportunities", "schema", "fields", "{{fieldApiName}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0023844e-d4cb-467e-ae9f-fc9a2e95d5f1", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "opportunities", "schema", "fields", "{{fieldApiName}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"displayName\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"dataType\": \"\",\n \"isHidden\": \"\",\n \"isHtmlEncodingInEmail\": \"\",\n \"isSensitive\": \"\",\n \"isCustom\": \"\",\n \"isApiCreated\": \"\",\n \"length\": \"\"\n },\n {\n \"displayName\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"dataType\": \"\",\n \"isHidden\": \"\",\n \"isHtmlEncodingInEmail\": \"\",\n \"isSensitive\": \"\",\n \"isCustom\": \"\",\n \"isApiCreated\": \"\",\n \"length\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Sales Persons", "description": "CRUD operations on Sales Person records, used to associate an owner with leads and opportunities.", "item": [ { "id": "7e1ca5a5-b07e-4b3a-9994-5eb2ed85fd8f", "name": "Get SalesPersons", "request": { "name": "Get SalesPersons", "description": { "content": "Retrieves salesperson records from the destination instance based on the submitted filter. Required Permissions: Read-Only Sales Person, Read-Write Sales Person", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "salespersons.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The sales person field to filter on. Searchable fields can be retrieved with the Describe Sales Person call.", "type": "text/plain" }, "key": "filterType", "value": "" }, { "disabled": false, "description": { "content": "(Required) Comma separated list of search values.", "type": "text/plain" }, "key": "filterValues", "value": "," }, { "disabled": true, "description": { "content": "Comma-separated list of fields to include in the response", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "{{nextPageToken}}" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ff4dbc37-9a20-4a41-b823-6dacdddb962d", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "salespersons.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The sales person field to filter on. Searchable fields can be retrieved with the Describe Sales Person call.", "type": "text/plain" }, "key": "filterType", "value": "" }, { "disabled": false, "description": { "content": "(Required) Comma separated list of search values.", "type": "text/plain" }, "key": "filterValues", "value": "," }, { "disabled": true, "description": { "content": "Comma-separated list of fields to include in the response", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"seq\": \"\",\n \"status\": \"added\"\n },\n {\n \"id\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"seq\": \"\",\n \"status\": \"added\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "639f7096-f8f9-40ca-a6e1-544d2756acae", "name": "Sync SalesPersons", "request": { "name": "Sync SalesPersons", "description": { "content": "Allows inserts, updates, or upserts of salespersons to the target instance. Required Permissions: Read-Write Sales Person", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "salespersons.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"id\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"seq\": \"\",\n \"status\": \"added\"\n },\n {\n \"id\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"seq\": \"\",\n \"status\": \"created\"\n }\n ],\n \"action\": \"createOnly\",\n \"dedupeBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "6184b53c-18f4-48b8-a9f7-97580a8e130a", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "salespersons.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"id\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"seq\": \"\",\n \"status\": \"added\"\n },\n {\n \"id\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"seq\": \"\",\n \"status\": \"created\"\n }\n ],\n \"action\": \"createOnly\",\n \"dedupeBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"seq\": \"\",\n \"status\": \"added\"\n },\n {\n \"id\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"seq\": \"\",\n \"status\": \"added\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1bfa7e6f-42bb-4087-9d64-5b5bfffff876", "name": "Delete SalesPersons", "request": { "name": "Delete SalesPersons", "description": { "content": "Deletes 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", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "salespersons", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"id\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"seq\": \"\",\n \"status\": \"skipped\"\n },\n {\n \"id\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"seq\": \"\",\n \"status\": \"skipped\"\n }\n ],\n \"deleteBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "818261e8-5517-45b3-aa08-17f9f98d8278", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "salespersons", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"id\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"seq\": \"\",\n \"status\": \"skipped\"\n },\n {\n \"id\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"seq\": \"\",\n \"status\": \"skipped\"\n }\n ],\n \"deleteBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"seq\": \"\",\n \"status\": \"added\"\n },\n {\n \"id\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"seq\": \"\",\n \"status\": \"added\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a2254263-f59e-4e61-acc4-13dda5aaa55b", "name": "Describe SalesPersons", "request": { "name": "Describe SalesPersons", "description": { "content": "Returns metadata about salespersons and the fields available for interaction via the API. Required Permissions: Read-Only Sales Person, Read-Write Sales Person", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "salespersons", "describe.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "7c6856a2-edf1-43cb-a0ae-93c94f0aaf15", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "salespersons", "describe.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"createdAt\": \"\",\n \"dedupeFields\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"displayName\": \"\",\n \"pluralName\": \"\",\n \"fields\": [\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"length\": \"\",\n \"name\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\"\n },\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"length\": \"\",\n \"name\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\"\n }\n ],\n \"idField\": \"\",\n \"apiName\": \"\",\n \"relationships\": [\n {\n \"field\": \"\",\n \"relatedTo\": {\n \"field\": \"\",\n \"name\": \"\"\n },\n \"type\": \"\"\n },\n {\n \"field\": \"\",\n \"relatedTo\": {\n \"field\": \"\",\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n ],\n \"searchableFields\": [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ],\n \"updatedAt\": \"\",\n \"state\": \"draft\",\n \"version\": \"draft\"\n },\n {\n \"createdAt\": \"\",\n \"dedupeFields\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"displayName\": \"\",\n \"pluralName\": \"\",\n \"fields\": [\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"length\": \"\",\n \"name\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\"\n },\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"length\": \"\",\n \"name\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\"\n }\n ],\n \"idField\": \"\",\n \"apiName\": \"\",\n \"relationships\": [\n {\n \"field\": \"\",\n \"relatedTo\": {\n \"field\": \"\",\n \"name\": \"\"\n },\n \"type\": \"\"\n },\n {\n \"field\": \"\",\n \"relatedTo\": {\n \"field\": \"\",\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n ],\n \"searchableFields\": [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ],\n \"updatedAt\": \"\",\n \"state\": \"draft\",\n \"version\": \"draft\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Named Accounts", "description": "CRUD operations on Named Account records used by Account-Based Marketing.", "item": [ { "id": "ccbcd069-49ba-4444-8333-c59d577e6b74", "name": "Get NamedAccounts", "request": { "name": "Get NamedAccounts", "description": { "content": "Retrieves namedaccount records from the destination instance based on the submitted filter. Required Permissions: Read-Only Named Account, Read-Write Named Account", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "namedaccounts.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) NamedAccounts field to filter on. Can be any searchable fields", "type": "text/plain" }, "key": "filterType", "value": "" }, { "disabled": false, "description": { "content": "(Required) A comma-separated list of values to match against", "type": "text/plain" }, "key": "filterValues", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated list of fields to include in the response", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "{{nextPageToken}}" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6f0988d5-f898-480e-bcc3-c04b6eacd8ad", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "namedaccounts.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) NamedAccounts field to filter on. Can be any searchable fields", "type": "text/plain" }, "key": "filterType", "value": "" }, { "disabled": false, "description": { "content": "(Required) A comma-separated list of values to match against", "type": "text/plain" }, "key": "filterValues", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated list of fields to include in the response", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"removed\"\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"removed\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "917d7e91-311d-494d-9872-9a7d6eddfa7b", "name": "Sync NamedAccounts", "request": { "name": "Sync NamedAccounts", "description": { "content": "Allows inserts, updates, or upserts of namedaccounts to the target instance. Required Permissions: Read-Write Named Account", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "namedaccounts.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"created\"\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"updated\"\n }\n ],\n \"action\": \"updateOnly\",\n \"dedupeBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f659dde3-d840-41d4-8e84-9ce46893376d", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "namedaccounts.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"created\"\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"updated\"\n }\n ],\n \"action\": \"updateOnly\",\n \"dedupeBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"removed\"\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"removed\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1475c76d-5638-48bc-a536-49675fd94673", "name": "Delete NamedAccounts", "request": { "name": "Delete NamedAccounts", "description": { "content": "Deletes 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", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "namedaccounts", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"created\"\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"added\"\n }\n ],\n \"deleteBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "054b4aaa-5317-41ed-9798-6dc19d902766", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "namedaccounts", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"created\"\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"added\"\n }\n ],\n \"deleteBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"removed\"\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"removed\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2efa618b-a4ab-4745-92bc-4ed096265351", "name": "Describe NamedAccounts", "request": { "name": "Describe NamedAccounts", "description": { "content": "Returns metadata about namedaccounts and the fields available for interaction via the API. Required Permissions: Read-Only Named Account, Read-Write Named Account", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "namedaccounts", "describe.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b9587b12-4bcd-44f0-ac51-b235247b02a6", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "namedaccounts", "describe.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"createdAt\": \"\",\n \"dedupeFields\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"displayName\": \"\",\n \"pluralName\": \"\",\n \"fields\": [\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"length\": \"\",\n \"name\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\"\n },\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"length\": \"\",\n \"name\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\"\n }\n ],\n \"idField\": \"\",\n \"apiName\": \"\",\n \"relationships\": [\n {\n \"field\": \"\",\n \"relatedTo\": {\n \"field\": \"\",\n \"name\": \"\"\n },\n \"type\": \"\"\n },\n {\n \"field\": \"\",\n \"relatedTo\": {\n \"field\": \"\",\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n ],\n \"searchableFields\": [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ],\n \"updatedAt\": \"\",\n \"state\": \"draft\",\n \"version\": \"draft\"\n },\n {\n \"createdAt\": \"\",\n \"dedupeFields\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"displayName\": \"\",\n \"pluralName\": \"\",\n \"fields\": [\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"length\": \"\",\n \"name\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\"\n },\n {\n \"dataType\": \"\",\n \"displayName\": \"\",\n \"length\": \"\",\n \"name\": \"\",\n \"updateable\": \"\",\n \"crmManaged\": \"\"\n }\n ],\n \"idField\": \"\",\n \"apiName\": \"\",\n \"relationships\": [\n {\n \"field\": \"\",\n \"relatedTo\": {\n \"field\": \"\",\n \"name\": \"\"\n },\n \"type\": \"\"\n },\n {\n \"field\": \"\",\n \"relatedTo\": {\n \"field\": \"\",\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n ],\n \"searchableFields\": [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ],\n \"updatedAt\": \"\",\n \"state\": \"draft\",\n \"version\": \"draft\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3695b644-2805-4f31-abbc-5eb9571c40ad", "name": "Get Named Account Fields", "request": { "name": "Get Named Account Fields", "description": { "content": "Retrieves metadata for all named account fields in the target instance. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "namedaccounts", "schema", "fields.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "{{nextPageToken}}" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ca41deb5-4a3a-44c6-91a2-cfebe5896b8a", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "namedaccounts", "schema", "fields.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"displayName\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"dataType\": \"\",\n \"isHidden\": \"\",\n \"isHtmlEncodingInEmail\": \"\",\n \"isSensitive\": \"\",\n \"isCustom\": \"\",\n \"isApiCreated\": \"\",\n \"length\": \"\"\n },\n {\n \"displayName\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"dataType\": \"\",\n \"isHidden\": \"\",\n \"isHtmlEncodingInEmail\": \"\",\n \"isSensitive\": \"\",\n \"isCustom\": \"\",\n \"isApiCreated\": \"\",\n \"length\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "162e4923-3c43-41d9-8e53-afd95e8b7f56", "name": "Get Named Account Field by Name", "request": { "name": "Get Named Account Field by Name", "description": { "content": "Retrieves metadata for single named account field. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "namedaccounts", "schema", "fields", "{{fieldApiName}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9066a14e-0b83-4bdb-b6e4-25b2fc08b386", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "namedaccounts", "schema", "fields", "{{fieldApiName}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"displayName\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"dataType\": \"\",\n \"isHidden\": \"\",\n \"isHtmlEncodingInEmail\": \"\",\n \"isSensitive\": \"\",\n \"isCustom\": \"\",\n \"isApiCreated\": \"\",\n \"length\": \"\"\n },\n {\n \"displayName\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"dataType\": \"\",\n \"isHidden\": \"\",\n \"isHtmlEncodingInEmail\": \"\",\n \"isSensitive\": \"\",\n \"isCustom\": \"\",\n \"isApiCreated\": \"\",\n \"length\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Named Account Lists", "description": "Manage Named Account Lists and their membership for Account-Based Marketing.", "item": [ { "id": "9bc04642-869e-41eb-bee6-06d8188160dd", "name": "Get Named Account List Members", "request": { "name": "Get Named Account List Members", "description": { "content": "Retrieves the named accounts which are members of the given list. Required Permissions: Read-Only Named Account, Read-Write Named Account", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "namedAccountList", ":id", "namedAccounts.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Comma-separated list of fields to include in the response", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "{{nextPageToken}}" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Id of the named account list", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "fcce81dd-ecbc-4ac9-89a0-6d3526afdf28", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "namedAccountList", ":id", "namedAccounts.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Comma-separated list of fields to include in the response", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the named account list", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"removed\"\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"removed\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "776ae89f-3939-4e57-9896-13ce5630691d", "name": "Add Named Account List Members", "request": { "name": "Add Named Account List Members", "description": { "content": "Adds named account records to a named account list. Required Permissions: Read-Write Named Account", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "namedAccountList", ":id", "namedAccounts.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Id of target named account list", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"created\"\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"removed\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "396bc54d-9862-4214-aecb-51ea084a15ae", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "namedAccountList", ":id", "namedAccounts.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of target named account list", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"created\"\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"removed\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"removed\"\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"removed\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b77b8327-eba7-4060-a014-16f67fd8659d", "name": "Remove Named Account List Members", "request": { "name": "Remove Named Account List Members", "description": { "content": "Removes named account members from a named account list. Required Permissions: Read-Write Named Account", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "namedAccountList", ":id", "namedAccounts", "remove.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Id of target named account list", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"created\"\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"removed\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f61253ed-19cb-413f-8060-0468c36658ba", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "namedAccountList", ":id", "namedAccounts", "remove.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of target named account list", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"created\"\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"removed\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"removed\"\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"removed\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e8c3eda4-f85f-45be-a6a3-62a363d2ffe3", "name": "Get Named Account Lists", "request": { "name": "Get Named Account Lists", "description": { "content": "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", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "namedAccountLists.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The named account list field to filter on (\"dedupeFields\" or \"idFields\").", "type": "text/plain" }, "key": "filterType", "value": "" }, { "disabled": false, "description": { "content": "(Required) Comma-separated list of values to match against", "type": "text/plain" }, "key": "filterValues", "value": "" }, { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "{{nextPageToken}}" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b669dda9-7d18-43dd-b9a3-b4f71f24a12f", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "namedAccountLists.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The named account list field to filter on (\"dedupeFields\" or \"idFields\").", "type": "text/plain" }, "key": "filterType", "value": "" }, { "disabled": false, "description": { "content": "(Required) Comma-separated list of values to match against", "type": "text/plain" }, "key": "filterValues", "value": "" }, { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"createdAt\": \"\",\n \"name\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"added\",\n \"type\": \"\",\n \"updateable\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"createdAt\": \"\",\n \"name\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"skipped\",\n \"type\": \"\",\n \"updateable\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7420ee69-eec0-4612-a3fd-cca94c5de8e6", "name": "Sync Named Account Lists", "request": { "name": "Sync Named Account Lists", "description": { "content": "Creates and/or updates named account list records. Required Permissions: Read-Write Named Account List", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "namedAccountLists.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"createdAt\": \"\",\n \"name\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"updated\",\n \"type\": \"\",\n \"updateable\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"createdAt\": \"\",\n \"name\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"removed\",\n \"type\": \"\",\n \"updateable\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"action\": \"updateOnly\",\n \"dedupeBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "eded73cd-f9d1-4cc0-b05e-a8ed6a800666", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "namedAccountLists.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"createdAt\": \"\",\n \"name\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"updated\",\n \"type\": \"\",\n \"updateable\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"createdAt\": \"\",\n \"name\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"removed\",\n \"type\": \"\",\n \"updateable\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"action\": \"updateOnly\",\n \"dedupeBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"createdAt\": \"\",\n \"name\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"added\",\n \"type\": \"\",\n \"updateable\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"createdAt\": \"\",\n \"name\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"skipped\",\n \"type\": \"\",\n \"updateable\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3f92fdaa-b362-4390-b533-2667fd1f372a", "name": "Delete Named Account Lists", "request": { "name": "Delete Named Account Lists", "description": { "content": "Delete named account lists by dedupe fields, or by id field. Required Permissions: Read-Write Named Account List", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "namedAccountLists", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"createdAt\": \"\",\n \"name\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"added\",\n \"type\": \"\",\n \"updateable\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"createdAt\": \"\",\n \"name\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"added\",\n \"type\": \"\",\n \"updateable\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"deleteBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7986f5e2-691d-4464-a554-7f49999f0624", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "namedAccountLists", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"createdAt\": \"\",\n \"name\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"added\",\n \"type\": \"\",\n \"updateable\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"createdAt\": \"\",\n \"name\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"added\",\n \"type\": \"\",\n \"updateable\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"deleteBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"createdAt\": \"\",\n \"name\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"added\",\n \"type\": \"\",\n \"updateable\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"marketoGUID\": \"\",\n \"seq\": \"\",\n \"createdAt\": \"\",\n \"name\": \"\",\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"status\": \"skipped\",\n \"type\": \"\",\n \"updateable\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Usage", "description": "Daily API call and error statistics, broken down by user and by day.", "item": [ { "id": "3608d673-69e4-4162-b59a-8bb582647b3e", "name": "Get Daily Errors", "request": { "name": "Get Daily Errors", "description": { "content": "Retrieves a count of each error type they have encountered in the current day. Required Permissions: None", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "stats", "errors.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1101bf0a-ff98-4ab8-b606-8d25aa8a311e", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "stats", "errors.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"date\": \"\",\n \"errors\": [\n {\n \"count\": \"\",\n \"errorCode\": \"\"\n },\n {\n \"count\": \"\",\n \"errorCode\": \"\"\n }\n ],\n \"total\": \"\"\n },\n {\n \"date\": \"\",\n \"errors\": [\n {\n \"count\": \"\",\n \"errorCode\": \"\"\n },\n {\n \"count\": \"\",\n \"errorCode\": \"\"\n }\n ],\n \"total\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b060620c-4228-490f-a2ae-e18a7261017d", "name": "Get Weekly Errors", "request": { "name": "Get Weekly Errors", "description": { "content": "Returns a count of each error type they have encountered in the past 7 days. Required Permissions: None", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "stats", "errors", "last7days.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e334173e-a26e-4371-a6ff-5919cdd49b5c", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "stats", "errors", "last7days.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"date\": \"\",\n \"errors\": [\n {\n \"count\": \"\",\n \"errorCode\": \"\"\n },\n {\n \"count\": \"\",\n \"errorCode\": \"\"\n }\n ],\n \"total\": \"\"\n },\n {\n \"date\": \"\",\n \"errors\": [\n {\n \"count\": \"\",\n \"errorCode\": \"\"\n },\n {\n \"count\": \"\",\n \"errorCode\": \"\"\n }\n ],\n \"total\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0d6ca2b6-60ec-456d-a4b2-ae51a58b65c4", "name": "Get Daily Usage", "request": { "name": "Get Daily Usage", "description": { "content": "Returns the number of calls consumed for the day. Required Permissions: None", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "stats", "usage.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "745763e8-10a4-408e-8833-4dd1566b3e6d", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "stats", "usage.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"date\": \"\",\n \"total\": \"\",\n \"users\": [\n {\n \"count\": \"\",\n \"userId\": \"\"\n },\n {\n \"count\": \"\",\n \"userId\": \"\"\n }\n ]\n },\n {\n \"date\": \"\",\n \"total\": \"\",\n \"users\": [\n {\n \"count\": \"\",\n \"userId\": \"\"\n },\n {\n \"count\": \"\",\n \"userId\": \"\"\n }\n ]\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "56c2c2f0-5aaa-4971-bb9a-db3c0d924153", "name": "Get Weekly Usage", "request": { "name": "Get Weekly Usage", "description": { "content": "Returns the number of calls consumed in the past 7 days. Required Permissions: None", "type": "text/plain" }, "url": { "path": [ "rest", "v1", "stats", "usage", "last7days.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d42484cb-ca29-466a-a946-a5493d76f6d2", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v1", "stats", "usage", "last7days.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"date\": \"\",\n \"total\": \"\",\n \"users\": [\n {\n \"count\": \"\",\n \"userId\": \"\"\n },\n {\n \"count\": \"\",\n \"userId\": \"\"\n }\n ]\n },\n {\n \"date\": \"\",\n \"total\": \"\",\n \"users\": [\n {\n \"count\": \"\",\n \"userId\": \"\"\n },\n {\n \"count\": \"\",\n \"userId\": \"\"\n }\n ]\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Bulk Export Leads", "description": "Asynchronous bulk extract of person records to a CSV/TSV/SSV file. Create a job, enqueue it, poll its status, then download the file.", "item": [ { "id": "27be77ba-389b-40e9-b2dd-425b7817d4ed", "name": "Get Export Lead Jobs", "request": { "name": "Get Export Lead Jobs", "description": { "content": "Returns a list of export jobs that were created in the past 7 days. Required Permissions: Read-Only Lead", "type": "text/plain" }, "url": { "path": [ "bulk", "v1", "leads", "export.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Comma separated list of statuses to filter on.", "type": "text/plain" }, "key": "status", "value": "failed" }, { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "{{nextPageToken}}" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6a983f66-5b16-4a4e-ade3-7c6584eeb163", "name": "OK", "originalRequest": { "url": { "path": [ "bulk", "v1", "leads", "export.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Comma separated list of statuses to filter on.", "type": "text/plain" }, "key": "status", "value": "processing" }, { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n },\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6db12155-6502-47bc-8a0d-6cf53ef00eb4", "name": "Create Export Lead Job", "request": { "name": "Create Export Lead Job", "description": { "content": "Create 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", "type": "text/plain" }, "url": { "path": [ "bulk", "v1", "leads", "export", "create.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"\",\n \"\"\n ],\n \"filter\": {\n \"createdAt\": {\n \"endAt\": \"\",\n \"startAt\": \"\"\n },\n \"smartListId\": \"\",\n \"smartListName\": \"\",\n \"staticListId\": \"\",\n \"staticListName\": \"\",\n \"updatedAt\": {\n \"endAt\": \"\",\n \"startAt\": \"\"\n }\n },\n \"columnHeaderNames\": {\n \"name\": \"\",\n \"value\": \"\"\n },\n \"format\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9e230cbb-c38b-41d1-b8cd-433ec94ebab8", "name": "OK", "originalRequest": { "url": { "path": [ "bulk", "v1", "leads", "export", "create.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"\",\n \"\"\n ],\n \"filter\": {\n \"createdAt\": {\n \"endAt\": \"\",\n \"startAt\": \"\"\n },\n \"smartListId\": \"\",\n \"smartListName\": \"\",\n \"staticListId\": \"\",\n \"staticListName\": \"\",\n \"updatedAt\": {\n \"endAt\": \"\",\n \"startAt\": \"\"\n }\n },\n \"columnHeaderNames\": {\n \"name\": \"\",\n \"value\": \"\"\n },\n \"format\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n },\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2623b86a-b7e2-4971-b9c8-202a259e23cc", "name": "Cancel Export Lead Job", "request": { "name": "Cancel Export Lead Job", "description": { "content": "Cancel export job. Required Permissions: Read-Only Lead", "type": "text/plain" }, "url": { "path": [ "bulk", "v1", "leads", "export", ":exportId", "cancel.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "exportId", "disabled": false, "description": { "content": "(Required) Id of export batch job.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "d2bac1e3-efe8-41b1-9b0c-49cf6bd76b69", "name": "OK", "originalRequest": { "url": { "path": [ "bulk", "v1", "leads", "export", ":exportId", "cancel.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of export batch job.", "type": "text/plain" }, "type": "any", "value": "", "key": "exportId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n },\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8585ee7d-b023-4b19-ae46-c698141a628e", "name": "Enqueue Export Lead Job", "request": { "name": "Enqueue Export Lead Job", "description": { "content": "Enqueue 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", "type": "text/plain" }, "url": { "path": [ "bulk", "v1", "leads", "export", ":exportId", "enqueue.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "exportId", "disabled": false, "description": { "content": "(Required) Id of export batch job.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "edf473e1-20ff-40ac-9f54-2e3de5c1e5bb", "name": "OK", "originalRequest": { "url": { "path": [ "bulk", "v1", "leads", "export", ":exportId", "enqueue.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of export batch job.", "type": "text/plain" }, "type": "any", "value": "", "key": "exportId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n },\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5d7bcce7-704e-40ad-b14c-a9526fcd3c7e", "name": "Get Export Lead File", "request": { "name": "Get Export Lead File", "description": { "content": "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

The file format is specified by calling the Create Export Lead Job endpoint. The following is an example of the default file format (\"CSV\").

firstName,lastName,email
Marvin,Gaye,marvin.gaye@motown.com", "type": "text/plain" }, "url": { "path": [ "bulk", "v1", "leads", "export", ":exportId", "file.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "exportId", "disabled": false, "description": { "content": "(Required) Id of export batch job.", "type": "text/plain" } } ] }, "header": [ { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "Range", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "df533d8c-a447-4651-a90e-efc1ae2e7eb8", "name": "OK", "originalRequest": { "url": { "path": [ "bulk", "v1", "leads", "export", ":exportId", "file.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of export batch job.", "type": "text/plain" }, "type": "any", "value": "", "key": "exportId" } ] }, "header": [ { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "Range", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "99e04a31-15fd-4c10-83d4-b00feee31722", "name": "Get Export Lead Job Status", "request": { "name": "Get Export Lead Job Status", "description": { "content": "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", "type": "text/plain" }, "url": { "path": [ "bulk", "v1", "leads", "export", ":exportId", "status.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "exportId", "disabled": false, "description": { "content": "(Required) Id of export batch job.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1902ecd0-eaef-45bf-acc2-56604afe44ba", "name": "OK", "originalRequest": { "url": { "path": [ "bulk", "v1", "leads", "export", ":exportId", "status.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of export batch job.", "type": "text/plain" }, "type": "any", "value": "", "key": "exportId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n },\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Bulk Export Activities", "description": "Asynchronous bulk extract of activity log records. Create a job, enqueue it, poll its status, then download the file.", "item": [ { "id": "ecf22d76-2160-4596-906f-b67498700bb8", "name": "Get Export Activity Jobs", "request": { "name": "Get Export Activity Jobs", "description": { "content": "Returns a list of export jobs that were created in the past 7 days. Required Permissions: Read-Only Activity", "type": "text/plain" }, "url": { "path": [ "bulk", "v1", "activities", "export.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Comma separated list of statuses to filter on.", "type": "text/plain" }, "key": "status", "value": "failed" }, { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "{{nextPageToken}}" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1a357456-f6c1-430e-868f-3194c580f822", "name": "OK", "originalRequest": { "url": { "path": [ "bulk", "v1", "activities", "export.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Comma separated list of statuses to filter on.", "type": "text/plain" }, "key": "status", "value": "processing" }, { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n },\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "96be1a9b-f16e-465a-b39c-4e5e35df313b", "name": "Create Export Activity Job", "request": { "name": "Create Export Activity Job", "description": { "content": "Create 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", "type": "text/plain" }, "url": { "path": [ "bulk", "v1", "activities", "export", "create.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"\",\n \"\"\n ],\n \"filter\": {\n \"createdAt\": {\n \"endAt\": \"\",\n \"startAt\": \"\"\n },\n \"activityTypeIds\": [\n \"\",\n \"\"\n ],\n \"primaryAttributeValueIds\": [\n \"\",\n \"\"\n ],\n \"primaryAttributeValues\": [\n \"\",\n \"\"\n ]\n },\n \"columnHeaderNames\": {\n \"name\": \"\",\n \"value\": \"\"\n },\n \"format\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "54c03431-13c0-4e26-aed0-4c28a1095c7c", "name": "OK", "originalRequest": { "url": { "path": [ "bulk", "v1", "activities", "export", "create.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"\",\n \"\"\n ],\n \"filter\": {\n \"createdAt\": {\n \"endAt\": \"\",\n \"startAt\": \"\"\n },\n \"activityTypeIds\": [\n \"\",\n \"\"\n ],\n \"primaryAttributeValueIds\": [\n \"\",\n \"\"\n ],\n \"primaryAttributeValues\": [\n \"\",\n \"\"\n ]\n },\n \"columnHeaderNames\": {\n \"name\": \"\",\n \"value\": \"\"\n },\n \"format\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n },\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3df89f74-fd0f-4735-963b-a7da3c2b603d", "name": "Cancel Export Activity Job", "request": { "name": "Cancel Export Activity Job", "description": { "content": "Cancel export job. Required Permissions: Read-Only Activity", "type": "text/plain" }, "url": { "path": [ "bulk", "v1", "activities", "export", ":exportId", "cancel.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "exportId", "disabled": false, "description": { "content": "(Required) Id of export batch job.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "0d862571-08db-409b-b8d8-53e1de905785", "name": "OK", "originalRequest": { "url": { "path": [ "bulk", "v1", "activities", "export", ":exportId", "cancel.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of export batch job.", "type": "text/plain" }, "type": "any", "value": "", "key": "exportId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n },\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "81b00459-42c8-4142-8323-04ced6e1132f", "name": "Enqueue Export Activity Job", "request": { "name": "Enqueue Export Activity Job", "description": { "content": "Enqueue 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", "type": "text/plain" }, "url": { "path": [ "bulk", "v1", "activities", "export", ":exportId", "enqueue.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "exportId", "disabled": false, "description": { "content": "(Required) Id of export batch job.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "bbc098f6-d059-4d4b-a3e5-5a315f240e5f", "name": "OK", "originalRequest": { "url": { "path": [ "bulk", "v1", "activities", "export", ":exportId", "enqueue.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of export batch job.", "type": "text/plain" }, "type": "any", "value": "", "key": "exportId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n },\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "10a45b76-8772-4af4-beb6-40bedd6aa63c", "name": "Get Export Activity File", "request": { "name": "Get Export Activity File", "description": { "content": "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

The 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.

marketoGUID,leadId,activityDate,activityTypeId,campaignId,primaryAttributeValueId,primaryAttributeValue, attributes
122323,6,2013-09-26T06:56:35+0000,12,11,6,Owyliphys Iledil,[{\"name\":\"Source Type\",\"value\":\"Web page visit\"}]", "type": "text/plain" }, "url": { "path": [ "bulk", "v1", "activities", "export", ":exportId", "file.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "exportId", "disabled": false, "description": { "content": "(Required) Id of export batch job.", "type": "text/plain" } } ] }, "header": [ { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "Range", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "303df629-68b9-402f-87a2-e81ca897c823", "name": "OK", "originalRequest": { "url": { "path": [ "bulk", "v1", "activities", "export", ":exportId", "file.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of export batch job.", "type": "text/plain" }, "type": "any", "value": "", "key": "exportId" } ] }, "header": [ { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "Range", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "240e2373-dcae-4a75-a5cc-2f78f546458e", "name": "Get Export Activity Job Status", "request": { "name": "Get Export Activity Job Status", "description": { "content": "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", "type": "text/plain" }, "url": { "path": [ "bulk", "v1", "activities", "export", ":exportId", "status.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "exportId", "disabled": false, "description": { "content": "(Required) Id of export batch job.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0c04ee76-b9bb-4072-9328-d510a72a7eba", "name": "OK", "originalRequest": { "url": { "path": [ "bulk", "v1", "activities", "export", ":exportId", "status.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of export batch job.", "type": "text/plain" }, "type": "any", "value": "", "key": "exportId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n },\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Bulk Export Custom Objects", "description": "Asynchronous bulk extract of custom object records. Create a job, enqueue it, poll its status, then download the file.", "item": [ { "id": "fee2c145-3216-4352-97cd-f9c859b81ba3", "name": "Get Export Custom Object Jobs", "request": { "name": "Get Export Custom Object Jobs", "description": { "content": "Returns a list of export jobs that were created in the past 7 days. Required Permissions: Read-Only Custom Object", "type": "text/plain" }, "url": { "path": [ "bulk", "v1", "customobjects", ":apiName", "export.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Comma separated list of statuses to filter on.", "type": "text/plain" }, "key": "status", "value": "failed" }, { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "{{nextPageToken}}" } ], "variable": [ { "type": "any", "value": "", "key": "apiName", "disabled": false, "description": { "content": "(Required) API Name of the custom object for the export batch job.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3f0af3f1-43fe-4ad9-8751-9e367c2c0cfb", "name": "OK", "originalRequest": { "url": { "path": [ "bulk", "v1", "customobjects", ":apiName", "export.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Comma separated list of statuses to filter on.", "type": "text/plain" }, "key": "status", "value": "processing" }, { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) API Name of the custom object for the export batch job.", "type": "text/plain" }, "type": "any", "value": "", "key": "apiName" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n },\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "574037a2-c708-486c-b750-28d5258bf722", "name": "Create Export Custom Object Job", "request": { "name": "Create Export Custom Object Job", "description": { "content": "Create 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", "type": "text/plain" }, "url": { "path": [ "bulk", "v1", "customobjects", ":apiName", "export", "create.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "apiName", "disabled": false, "description": { "content": "(Required) API Name of the custom object for the export batch job.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"\",\n \"\"\n ],\n \"filter\": {\n \"updatedAt\": {\n \"endAt\": \"\",\n \"startAt\": \"\"\n },\n \"smartListId\": \"\",\n \"smartListName\": \"\",\n \"staticListId\": \"\",\n \"staticListName\": \"\"\n },\n \"columnHeaderNames\": {\n \"name\": \"\",\n \"value\": \"\"\n },\n \"format\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "dcd99d68-cfe2-438b-bf53-95ed77d8b917", "name": "OK", "originalRequest": { "url": { "path": [ "bulk", "v1", "customobjects", ":apiName", "export", "create.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) API Name of the custom object for the export batch job.", "type": "text/plain" }, "type": "any", "value": "", "key": "apiName" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"\",\n \"\"\n ],\n \"filter\": {\n \"updatedAt\": {\n \"endAt\": \"\",\n \"startAt\": \"\"\n },\n \"smartListId\": \"\",\n \"smartListName\": \"\",\n \"staticListId\": \"\",\n \"staticListName\": \"\"\n },\n \"columnHeaderNames\": {\n \"name\": \"\",\n \"value\": \"\"\n },\n \"format\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n },\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "34ed8e27-c403-4ff9-b862-3ed1f398b0d2", "name": "Cancel Export Custom Object Job", "request": { "name": "Cancel Export Custom Object Job", "description": { "content": "Cancel export job. Required Permissions: Read-Only Custom Object", "type": "text/plain" }, "url": { "path": [ "bulk", "v1", "customobjects", ":apiName", "export", ":exportId", "cancel.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "apiName", "disabled": false, "description": { "content": "(Required) API Name of the custom object for the export batch job.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "exportId", "disabled": false, "description": { "content": "(Required) Id of export batch job.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "46f95aa6-d813-4cbf-9bf4-3d536e6460bf", "name": "OK", "originalRequest": { "url": { "path": [ "bulk", "v1", "customobjects", ":apiName", "export", ":exportId", "cancel.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) API Name of the custom object for the export batch job.", "type": "text/plain" }, "type": "any", "value": "", "key": "apiName" }, { "disabled": false, "description": { "content": "(Required) Id of export batch job.", "type": "text/plain" }, "type": "any", "value": "", "key": "exportId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n },\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "58cdb7c1-31b9-4ca5-9738-8adf441104bf", "name": "Enqueue Export Custom Object Job", "request": { "name": "Enqueue Export Custom Object Job", "description": { "content": "Enqueue 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", "type": "text/plain" }, "url": { "path": [ "bulk", "v1", "customobjects", ":apiName", "export", ":exportId", "enqueue.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "apiName", "disabled": false, "description": { "content": "(Required) API Name of the custom object for the export batch job.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "exportId", "disabled": false, "description": { "content": "(Required) Id of export batch job.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "8899123f-b787-4dc9-98f1-e9285e727785", "name": "OK", "originalRequest": { "url": { "path": [ "bulk", "v1", "customobjects", ":apiName", "export", ":exportId", "enqueue.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) API Name of the custom object for the export batch job.", "type": "text/plain" }, "type": "any", "value": "", "key": "apiName" }, { "disabled": false, "description": { "content": "(Required) Id of export batch job.", "type": "text/plain" }, "type": "any", "value": "", "key": "exportId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n },\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "18ec5cf2-a39b-43a0-828a-d5e559c5c9ee", "name": "Get Export Custom Object File", "request": { "name": "Get Export Custom Object File", "description": { "content": "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

The file format is specified by calling the Create Export Custom Object Job endpoint. The following is an example of the default file format (\"CSV\").

leadId,marketoGUID,itemName
11,c93f0494-bbd9-44e8-9c0e-dae9b525073f,Hoka One One Mach 4", "type": "text/plain" }, "url": { "path": [ "bulk", "v1", "customobjects", ":apiName", "export", ":exportId", "file.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "apiName", "disabled": false, "description": { "content": "(Required) API Name of the custom object for the export batch job.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "exportId", "disabled": false, "description": { "content": "(Required) Id of export batch job.", "type": "text/plain" } } ] }, "header": [ { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "Range", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4d9c36a1-b2bf-4084-b866-bff693f0e49a", "name": "OK", "originalRequest": { "url": { "path": [ "bulk", "v1", "customobjects", ":apiName", "export", ":exportId", "file.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) API Name of the custom object for the export batch job.", "type": "text/plain" }, "type": "any", "value": "", "key": "apiName" }, { "disabled": false, "description": { "content": "(Required) Id of export batch job.", "type": "text/plain" }, "type": "any", "value": "", "key": "exportId" } ] }, "header": [ { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "Range", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f6c60e80-6ecb-4ea9-8c04-5be43e8cff85", "name": "Get Export Custom Object Job Status", "request": { "name": "Get Export Custom Object Job Status", "description": { "content": "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", "type": "text/plain" }, "url": { "path": [ "bulk", "v1", "customobjects", ":apiName", "export", ":exportId", "status.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "apiName", "disabled": false, "description": { "content": "(Required) API Name of the custom object for the export batch job.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "exportId", "disabled": false, "description": { "content": "(Required) Id of export batch job.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1f2204eb-9c30-4ba2-9334-2da5905a4442", "name": "OK", "originalRequest": { "url": { "path": [ "bulk", "v1", "customobjects", ":apiName", "export", ":exportId", "status.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) API Name of the custom object for the export batch job.", "type": "text/plain" }, "type": "any", "value": "", "key": "apiName" }, { "disabled": false, "description": { "content": "(Required) Id of export batch job.", "type": "text/plain" }, "type": "any", "value": "", "key": "exportId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n },\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Bulk Export Program Members", "description": "Asynchronous bulk extract of program member records. Create a job, enqueue it, poll its status, then download the file.", "item": [ { "id": "84531c09-80ff-42d4-becc-23dc83864d11", "name": "Get Export Program Member Jobs", "request": { "name": "Get Export Program Member Jobs", "description": { "content": "Returns a list of export jobs that were created in the past 7 days. Required Permissions: Read-Only Lead", "type": "text/plain" }, "url": { "path": [ "bulk", "v1", "program", "members", "export.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Comma separated list of statuses to filter on.", "type": "text/plain" }, "key": "status", "value": "failed" }, { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "{{nextPageToken}}" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1be7b19d-05ab-419a-a46b-5bc7847d6941", "name": "OK", "originalRequest": { "url": { "path": [ "bulk", "v1", "program", "members", "export.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Comma separated list of statuses to filter on.", "type": "text/plain" }, "key": "status", "value": "processing" }, { "disabled": true, "description": { "content": "The batch size to return. The max and default value is 300.", "type": "text/plain" }, "key": "batchSize", "value": "" }, { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "nextPageToken", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n },\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bb76ffbd-bcb0-4d68-96cd-18a7e09a0e01", "name": "Create Export Program Member Job", "request": { "name": "Create Export Program Member Job", "description": { "content": "Create 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", "type": "text/plain" }, "url": { "path": [ "bulk", "v1", "program", "members", "export", "create.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"\",\n \"\"\n ],\n \"filter\": {\n \"programId\": \"\",\n \"programIds\": [\n \"\",\n \"\"\n ],\n \"isExhausted\": \"\",\n \"nurtureCadence\": \"paused\",\n \"statusNames\": [\n \"\",\n \"\"\n ],\n \"updatedAt\": {\n \"endAt\": \"\",\n \"startAt\": \"\"\n }\n },\n \"columnHeaderNames\": {\n \"name\": \"\",\n \"value\": \"\"\n },\n \"format\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "67b91c2f-a37e-498b-9bf8-b23604748ce0", "name": "OK", "originalRequest": { "url": { "path": [ "bulk", "v1", "program", "members", "export", "create.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"\",\n \"\"\n ],\n \"filter\": {\n \"programId\": \"\",\n \"programIds\": [\n \"\",\n \"\"\n ],\n \"isExhausted\": \"\",\n \"nurtureCadence\": \"paused\",\n \"statusNames\": [\n \"\",\n \"\"\n ],\n \"updatedAt\": {\n \"endAt\": \"\",\n \"startAt\": \"\"\n }\n },\n \"columnHeaderNames\": {\n \"name\": \"\",\n \"value\": \"\"\n },\n \"format\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n },\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3b7f37b2-10bf-4925-9318-0facecf7ba8a", "name": "Cancel Export Program Member Job", "request": { "name": "Cancel Export Program Member Job", "description": { "content": "Cancel export job. Required Permissions: Read-Only Lead", "type": "text/plain" }, "url": { "path": [ "bulk", "v1", "program", "members", "export", ":exportId", "cancel.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "exportId", "disabled": false, "description": { "content": "(Required) Id of export batch job.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "d8d1c0dd-7d2a-401b-93bf-3445ab528fbd", "name": "OK", "originalRequest": { "url": { "path": [ "bulk", "v1", "program", "members", "export", ":exportId", "cancel.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of export batch job.", "type": "text/plain" }, "type": "any", "value": "", "key": "exportId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n },\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9ca49595-a57d-4995-bc9a-cb76271356d7", "name": "Enqueue Export Program Member Job", "request": { "name": "Enqueue Export Program Member Job", "description": { "content": "Enqueue 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", "type": "text/plain" }, "url": { "path": [ "bulk", "v1", "program", "members", "export", ":exportId", "enqueue.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "exportId", "disabled": false, "description": { "content": "(Required) Id of export batch job.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "a78f8301-92cd-4e4d-bbf7-899a68971f07", "name": "OK", "originalRequest": { "url": { "path": [ "bulk", "v1", "program", "members", "export", ":exportId", "enqueue.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of export batch job.", "type": "text/plain" }, "type": "any", "value": "", "key": "exportId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n },\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ac82920b-46ee-4f52-bb59-0389c856c97e", "name": "Get Export Program Member File", "request": { "name": "Get Export Program Member File", "description": { "content": "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

The file format is specified by calling the Create Export Program Member Job endpoint. The following is an example of the default file format (\"CSV\").

firstName,lastName,email
Marvin,Gaye,marvin.gaye@motown.com", "type": "text/plain" }, "url": { "path": [ "bulk", "v1", "program", "members", "export", ":exportId", "file.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "exportId", "disabled": false, "description": { "content": "(Required) Id of export batch job.", "type": "text/plain" } } ] }, "header": [ { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "Range", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "67e29011-d608-4f26-9c7e-4eac2227551e", "name": "OK", "originalRequest": { "url": { "path": [ "bulk", "v1", "program", "members", "export", ":exportId", "file.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of export batch job.", "type": "text/plain" }, "type": "any", "value": "", "key": "exportId" } ] }, "header": [ { "disabled": true, "description": { "content": "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.", "type": "text/plain" }, "key": "Range", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fe9df15c-6a9f-43ad-a9cc-69a17a1c064c", "name": "Get Export Program Member Job Status", "request": { "name": "Get Export Program Member Job Status", "description": { "content": "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", "type": "text/plain" }, "url": { "path": [ "bulk", "v1", "program", "members", "export", ":exportId", "status.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "exportId", "disabled": false, "description": { "content": "(Required) Id of export batch job.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "360612ed-21b4-4024-925e-20444aa4e9bf", "name": "OK", "originalRequest": { "url": { "path": [ "bulk", "v1", "program", "members", "export", ":exportId", "status.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of export batch job.", "type": "text/plain" }, "type": "any", "value": "", "key": "exportId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n },\n {\n \"exportId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"errorMsg\": \"\",\n \"fileSize\": \"\",\n \"fileChecksum\": \"\",\n \"finishedAt\": \"\",\n \"format\": \"\",\n \"numberOfRecords\": \"\",\n \"queuedAt\": \"\",\n \"startedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Bulk Import Leads", "description": "Asynchronous bulk import of person records from a CSV/TSV/SSV file, with status polling and failure/warning file retrieval.", "item": [ { "id": "5ad5dd0c-15f3-41cb-8b6b-4835706e8d47", "name": "Import Leads", "request": { "name": "Import Leads", "description": { "content": "Imports a file containing data records into the target instance. Required Permissions: Read-Write Lead", "type": "text/plain" }, "url": { "path": [ "bulk", "v1", "leads.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Import file format. (This can only be one of csv,tsv,ssv)", "type": "text/plain" }, "key": "format", "value": "ssv" }, { "disabled": true, "description": { "content": "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. ", "type": "text/plain" }, "key": "lookupField", "value": "" }, { "disabled": true, "description": { "content": "Name of the lead partition to import to.", "type": "text/plain" }, "key": "partitionName", "value": "" }, { "disabled": true, "description": { "content": "Id of the static list to import into.", "type": "text/plain" }, "key": "listId", "value": "" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) File containing the data records to import.", "type": "text/plain" }, "key": "file", "type": "file" } ] }, "auth": null }, "response": [ { "id": "da62b965-a1eb-41f5-9d25-27a8abb5b04d", "name": "OK", "originalRequest": { "url": { "path": [ "bulk", "v1", "leads.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Import file format. (This can only be one of csv,tsv,ssv)", "type": "text/plain" }, "key": "format", "value": "ssv" }, { "disabled": true, "description": { "content": "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. ", "type": "text/plain" }, "key": "lookupField", "value": "" }, { "disabled": true, "description": { "content": "Name of the lead partition to import to.", "type": "text/plain" }, "key": "partitionName", "value": "" }, { "disabled": true, "description": { "content": "Id of the static list to import into.", "type": "text/plain" }, "key": "listId", "value": "" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) File containing the data records to import.", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"batchId\": \"\",\n \"numOfLeadsProcessed\": \"\",\n \"status\": \"\",\n \"importId\": \"\",\n \"message\": \"\",\n \"numOfRowsFailed\": \"\",\n \"numOfRowsWithWarning\": \"\"\n },\n {\n \"batchId\": \"\",\n \"numOfLeadsProcessed\": \"\",\n \"status\": \"\",\n \"importId\": \"\",\n \"message\": \"\",\n \"numOfRowsFailed\": \"\",\n \"numOfRowsWithWarning\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "87fd65ff-0bbc-41e9-8e43-ad72d44ff8d1", "name": "Get Import Lead Status", "request": { "name": "Get Import Lead Status", "description": { "content": "Returns the status of an import batch job. Required Permissions: Read-Write Lead", "type": "text/plain" }, "url": { "path": [ "bulk", "v1", "leads", "batch", "{{batchId}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ef21e0a6-e497-4cee-829a-1880388f5af0", "name": "OK", "originalRequest": { "url": { "path": [ "bulk", "v1", "leads", "batch", "{{batchId}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"batchId\": \"\",\n \"numOfLeadsProcessed\": \"\",\n \"status\": \"\",\n \"importId\": \"\",\n \"message\": \"\",\n \"numOfRowsFailed\": \"\",\n \"numOfRowsWithWarning\": \"\"\n },\n {\n \"batchId\": \"\",\n \"numOfLeadsProcessed\": \"\",\n \"status\": \"\",\n \"importId\": \"\",\n \"message\": \"\",\n \"numOfRowsFailed\": \"\",\n \"numOfRowsWithWarning\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fe5e022b-0d90-460e-aa36-99bdc18898a8", "name": "Get Import Lead Failures", "request": { "name": "Get Import Lead Failures", "description": { "content": "Returns the list of failures for the import batch job. Required Permissions: Read-Write Lead", "type": "text/plain" }, "url": { "path": [ "bulk", "v1", "leads", "batch", ":batchId", "failures.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "batchId", "disabled": false, "description": { "content": "(Required) Id of the import batch job.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "47c24198-4737-4ded-95c4-516673458bf5", "name": "OK", "originalRequest": { "url": { "path": [ "bulk", "v1", "leads", "batch", ":batchId", "failures.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the import batch job.", "type": "text/plain" }, "type": "any", "value": "", "key": "batchId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0277a4f4-528e-4a88-88bb-efe8f0b5db8f", "name": "Get Import Lead Warnings", "request": { "name": "Get Import Lead Warnings", "description": { "content": "Returns the list of warnings for the import batch job. Required Permissions: Read-Write Lead", "type": "text/plain" }, "url": { "path": [ "bulk", "v1", "leads", "batch", ":batchId", "warnings.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "batchId", "disabled": false, "description": { "content": "(Required) Id of the import batch job.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0761eea0-bcf3-4212-b53f-356c2e4c9195", "name": "OK", "originalRequest": { "url": { "path": [ "bulk", "v1", "leads", "batch", ":batchId", "warnings.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the import batch job.", "type": "text/plain" }, "type": "any", "value": "", "key": "batchId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Bulk Import Custom Objects", "description": "Asynchronous bulk import of custom object records from a CSV/TSV/SSV file, with status polling and failure/warning file retrieval.", "item": [ { "id": "e839fcf9-0a9c-488a-8a39-b0944f438440", "name": "Import Custom Objects", "request": { "name": "Import Custom Objects", "description": { "content": "Imports a file containing data records into the target instance. Required Permissions: Read-Write Custom Object", "type": "text/plain" }, "url": { "path": [ "bulk", "v1", "customobjects", ":apiName", "import.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Import file format. (This can only be one of csv,tsv,ssv)", "type": "text/plain" }, "key": "format", "value": "ssv" } ], "variable": [ { "type": "any", "value": "", "key": "apiName", "disabled": false, "description": { "content": "(Required) API Name of the custom object for the import batch job.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) File containing the data records to import.", "type": "text/plain" }, "key": "file", "type": "file" } ] }, "auth": null }, "response": [ { "id": "28b575a0-2629-4c70-829a-19510777e6eb", "name": "OK", "originalRequest": { "url": { "path": [ "bulk", "v1", "customobjects", ":apiName", "import.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Import file format. (This can only be one of csv,tsv,ssv)", "type": "text/plain" }, "key": "format", "value": "ssv" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) API Name of the custom object for the import batch job.", "type": "text/plain" }, "type": "any", "value": "", "key": "apiName" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) File containing the data records to import.", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"batchId\": \"\",\n \"objectApiName\": \"\",\n \"operation\": \"\",\n \"status\": \"\",\n \"importTime\": \"\",\n \"message\": \"\",\n \"numOfObjectsProcessed\": \"\",\n \"numOfRowsFailed\": \"\",\n \"numOfRowsWithWarning\": \"\"\n },\n {\n \"batchId\": \"\",\n \"objectApiName\": \"\",\n \"operation\": \"\",\n \"status\": \"\",\n \"importTime\": \"\",\n \"message\": \"\",\n \"numOfObjectsProcessed\": \"\",\n \"numOfRowsFailed\": \"\",\n \"numOfRowsWithWarning\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b5a8e346-2f23-40d2-87de-5ec4aabb3fd5", "name": "Get Import Custom Object Failures", "request": { "name": "Get Import Custom Object Failures", "description": { "content": "Returns the list of failures for the import batch job. Required Permissions: Read-Write Custom Object", "type": "text/plain" }, "url": { "path": [ "bulk", "v1", "customobjects", ":apiName", "import", ":batchId", "failures.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "apiName", "disabled": false, "description": { "content": "(Required) API Name of the custom object for the import batch job.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "batchId", "disabled": false, "description": { "content": "(Required) Id of the import batch job.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "547f3d44-b79c-4776-b201-fa777c227eaf", "name": "OK", "originalRequest": { "url": { "path": [ "bulk", "v1", "customobjects", ":apiName", "import", ":batchId", "failures.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) API Name of the custom object for the import batch job.", "type": "text/plain" }, "type": "any", "value": "", "key": "apiName" }, { "disabled": false, "description": { "content": "(Required) Id of the import batch job.", "type": "text/plain" }, "type": "any", "value": "", "key": "batchId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6266a14b-1c2d-4e2f-850a-f481a5fca20e", "name": "Get Import Custom Object Status", "request": { "name": "Get Import Custom Object Status", "description": { "content": "Returns the status of an import batch job. Required Permissions: Read-Write Custom Object", "type": "text/plain" }, "url": { "path": [ "bulk", "v1", "customobjects", ":apiName", "import", ":batchId", "status.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "apiName", "disabled": false, "description": { "content": "(Required) API Name of the custom object for the import batch job.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "batchId", "disabled": false, "description": { "content": "(Required) Id of the import batch job.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "7a1c67d8-94ee-4576-bcf5-d5a73f6977a0", "name": "OK", "originalRequest": { "url": { "path": [ "bulk", "v1", "customobjects", ":apiName", "import", ":batchId", "status.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) API Name of the custom object for the import batch job.", "type": "text/plain" }, "type": "any", "value": "", "key": "apiName" }, { "disabled": false, "description": { "content": "(Required) Id of the import batch job.", "type": "text/plain" }, "type": "any", "value": "", "key": "batchId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"batchId\": \"\",\n \"objectApiName\": \"\",\n \"operation\": \"\",\n \"status\": \"\",\n \"importTime\": \"\",\n \"message\": \"\",\n \"numOfObjectsProcessed\": \"\",\n \"numOfRowsFailed\": \"\",\n \"numOfRowsWithWarning\": \"\"\n },\n {\n \"batchId\": \"\",\n \"objectApiName\": \"\",\n \"operation\": \"\",\n \"status\": \"\",\n \"importTime\": \"\",\n \"message\": \"\",\n \"numOfObjectsProcessed\": \"\",\n \"numOfRowsFailed\": \"\",\n \"numOfRowsWithWarning\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"moreResult\": \"\",\n \"nextPageToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7accb18e-ef1b-483e-9c38-b600001ac4a7", "name": "Get Import Custom Object Warnings", "request": { "name": "Get Import Custom Object Warnings", "description": { "content": "Returns the list of warnings for the import batch job. Required Permissions: Read-Write Custom Object", "type": "text/plain" }, "url": { "path": [ "bulk", "v1", "customobjects", ":apiName", "import", ":batchId", "warnings.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "apiName", "disabled": false, "description": { "content": "(Required) API Name of the custom object for the import batch job.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "batchId", "disabled": false, "description": { "content": "(Required) Id of the import batch job.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "47b9008e-acc3-4835-bc98-a6adfaf69902", "name": "OK", "originalRequest": { "url": { "path": [ "bulk", "v1", "customobjects", ":apiName", "import", ":batchId", "warnings.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) API Name of the custom object for the import batch job.", "type": "text/plain" }, "type": "any", "value": "", "key": "apiName" }, { "disabled": false, "description": { "content": "(Required) Id of the import batch job.", "type": "text/plain" }, "type": "any", "value": "", "key": "batchId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Bulk Import Program Members", "description": "Asynchronous bulk import of program members from a CSV/TSV/SSV file, with status polling and failure/warning file retrieval.", "item": [ { "id": "0aa2f8d4-a63b-4de4-ab15-7c1b3b9e19cb", "name": "Get Import Program Member Failures", "request": { "name": "Get Import Program Member Failures", "description": { "content": "Returns the list of failures for the import batch job. Required Permissions: Read-Write Lead", "type": "text/plain" }, "url": { "path": [ "bulk", "v1", "program", "members", "import", ":batchId", "failures.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "batchId", "disabled": false, "description": { "content": "(Required) Id of the import batch job.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ea2839a0-4077-4076-9292-51794e1d5c1f", "name": "OK", "originalRequest": { "url": { "path": [ "bulk", "v1", "program", "members", "import", ":batchId", "failures.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the import batch job.", "type": "text/plain" }, "type": "any", "value": "", "key": "batchId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "da4444bc-bd18-41f1-8f36-4fd9e6f396af", "name": "Get Import Program Member Status", "request": { "name": "Get Import Program Member Status", "description": { "content": "Returns the status of an import batch job. Required Permissions: Read-Write Lead", "type": "text/plain" }, "url": { "path": [ "bulk", "v1", "program", "members", "import", ":batchId", "status.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "batchId", "disabled": false, "description": { "content": "(Required) Id of the import batch job.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e3fa3360-0d08-462f-bf9f-36d11df23f14", "name": "OK", "originalRequest": { "url": { "path": [ "bulk", "v1", "program", "members", "import", ":batchId", "status.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the import batch job.", "type": "text/plain" }, "type": "any", "value": "", "key": "batchId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"batchId\": \"\",\n \"importId\": \"\",\n \"status\": \"\"\n },\n {\n \"batchId\": \"\",\n \"importId\": \"\",\n \"status\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fd71bce9-8375-47f5-9ebe-f32c6c85708a", "name": "Get Import Program Member Warnings", "request": { "name": "Get Import Program Member Warnings", "description": { "content": "Returns the list of warnings for the import batch job. Required Permissions: Read-Write Lead", "type": "text/plain" }, "url": { "path": [ "bulk", "v1", "program", "members", "import", ":batchId", "warnings.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "batchId", "disabled": false, "description": { "content": "(Required) Id of the import batch job.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1cf8ba94-8e97-4ffe-930e-1a091f2f589c", "name": "OK", "originalRequest": { "url": { "path": [ "bulk", "v1", "program", "members", "import", ":batchId", "warnings.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the import batch job.", "type": "text/plain" }, "type": "any", "value": "", "key": "batchId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "12db5cdc-88de-4300-9afc-e8889e0c9370", "name": "Import Program Members", "request": { "name": "Import Program Members", "description": { "content": "Imports a file containing data records into the target instance. Required Permissions: Read-Write Lead", "type": "text/plain" }, "url": { "path": [ "bulk", "v1", "program", ":programId", "members", "import.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Program member status for members being added.", "type": "text/plain" }, "key": "programMemberStatus", "value": "" }, { "disabled": false, "description": { "content": "(Required) Import file format. (This can only be one of CSV,TSV,SSV)", "type": "text/plain" }, "key": "format", "value": "TSV" } ], "variable": [ { "type": "any", "value": "", "key": "programId", "disabled": false, "description": { "content": "(Required) Id of the program to add members to.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) File containing the data records to import.", "type": "text/plain" }, "key": "file", "type": "file" } ] }, "auth": null }, "response": [ { "id": "7f3769c7-7322-4305-9acd-fd1a3194ebde", "name": "OK", "originalRequest": { "url": { "path": [ "bulk", "v1", "program", ":programId", "members", "import.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Program member status for members being added.", "type": "text/plain" }, "key": "programMemberStatus", "value": "" }, { "disabled": false, "description": { "content": "(Required) Import file format. (This can only be one of CSV,TSV,SSV)", "type": "text/plain" }, "key": "format", "value": "TSV" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the program to add members to.", "type": "text/plain" }, "type": "any", "value": "", "key": "programId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) File containing the data records to import.", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"batchId\": \"\",\n \"importId\": \"\",\n \"status\": \"\"\n },\n {\n \"batchId\": \"\",\n \"importId\": \"\",\n \"status\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "Asset", "item": [ { "name": "Folders", "description": "Create, browse, and manage Design Studio and Marketing Activities folders.", "item": [ { "id": "9b6fca82-29c3-438b-81f7-ddd33e2e7f5e", "name": "Get Folder by Name", "request": { "name": "Get Folder by Name", "description": { "content": "Returns a folder record for the given name. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "folder", "byName.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Name of the folder. Not applicable for Programs", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Type of folder. 'Folder' or 'Program'", "type": "text/plain" }, "key": "type", "value": "" }, { "disabled": true, "description": { "content": "Parent folder reference", "type": "text/plain" }, "key": "root", "value": "" }, { "disabled": true, "description": { "content": "Name of the workspace", "type": "text/plain" }, "key": "workSpace", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "79fe98f7-8fe0-4656-a9eb-c9dfc7b335b4", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "folder", "byName.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Name of the folder. Not applicable for Programs", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Type of folder. 'Folder' or 'Program'", "type": "text/plain" }, "key": "type", "value": "" }, { "disabled": true, "description": { "content": "Parent folder reference", "type": "text/plain" }, "key": "root", "value": "" }, { "disabled": true, "description": { "content": "Name of the workspace", "type": "text/plain" }, "key": "workSpace", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"createdAt\": \"\",\n \"folderId\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"folderType\": \"Landing Page Form\",\n \"id\": \"\",\n \"isArchive\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"path\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"accessZoneId\": \"\",\n \"description\": \"\",\n \"isSystem\": \"\",\n \"workspace\": \"\"\n },\n {\n \"createdAt\": \"\",\n \"folderId\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"folderType\": \"Email\",\n \"id\": \"\",\n \"isArchive\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"path\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"accessZoneId\": \"\",\n \"description\": \"\",\n \"isSystem\": \"\",\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f94a6d03-5e8c-4276-a651-ff4e9f228da7", "name": "Get Folder by Id", "request": { "name": "Get Folder by Id", "description": { "content": "Returns the folder record with the given id. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "folder", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Type of folder. 'Folder' or 'Program' (This can only be one of Folder,Program)", "type": "text/plain" }, "key": "type", "value": "Folder" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a9c0d16a-0e58-40fd-a8ec-bd0bfd3e6912", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "folder", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Type of folder. 'Folder' or 'Program' (This can only be one of Folder,Program)", "type": "text/plain" }, "key": "type", "value": "Folder" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"createdAt\": \"\",\n \"folderId\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"folderType\": \"Landing Page Form\",\n \"id\": \"\",\n \"isArchive\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"path\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"accessZoneId\": \"\",\n \"description\": \"\",\n \"isSystem\": \"\",\n \"workspace\": \"\"\n },\n {\n \"createdAt\": \"\",\n \"folderId\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"folderType\": \"Email\",\n \"id\": \"\",\n \"isArchive\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"path\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"accessZoneId\": \"\",\n \"description\": \"\",\n \"isSystem\": \"\",\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "31cd7468-8138-43a6-9ee5-e44ab6453576", "name": "Update Folder Metadata", "request": { "name": "Update Folder Metadata", "description": { "content": "Updates the metadata for a given folder. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "folder", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Type of folder. 'Folder' or 'Program'", "type": "text/plain" }, "key": "type", "value": "Program" }, { "disabled": true, "description": { "content": "Description of the asset", "type": "text/plain" }, "key": "description", "value": "" }, { "disabled": true, "description": { "content": "Whether the folder is archived or not. Toggling this value will change the archival status of the folder", "type": "text/plain" }, "key": "isArchive", "value": "" }, { "disabled": true, "description": { "content": "Name of the Folder", "type": "text/plain" }, "key": "name", "value": "" } ] }, "auth": null }, "response": [ { "id": "e78ce3c8-9773-4c14-9ce8-95b6b3a17412", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "folder", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Type of folder. 'Folder' or 'Program'", "type": "text/plain" }, "key": "type", "value": "Program" }, { "disabled": true, "description": { "content": "Description of the asset", "type": "text/plain" }, "key": "description", "value": "" }, { "disabled": true, "description": { "content": "Whether the folder is archived or not. Toggling this value will change the archival status of the folder", "type": "text/plain" }, "key": "isArchive", "value": "" }, { "disabled": true, "description": { "content": "Name of the Folder", "type": "text/plain" }, "key": "name", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"createdAt\": \"\",\n \"folderId\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"folderType\": \"Landing Page Form\",\n \"id\": \"\",\n \"isArchive\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"path\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"accessZoneId\": \"\",\n \"description\": \"\",\n \"isSystem\": \"\",\n \"workspace\": \"\"\n },\n {\n \"createdAt\": \"\",\n \"folderId\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"folderType\": \"Email\",\n \"id\": \"\",\n \"isArchive\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"path\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"accessZoneId\": \"\",\n \"description\": \"\",\n \"isSystem\": \"\",\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fa87d83f-1593-4b80-8d2a-66ba5b11dac7", "name": "Get Folder Contents", "request": { "name": "Get Folder Contents", "description": { "content": "Returns records for the contents of a given folder. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "folder", ":id", "content.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of records to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": false, "description": { "content": "(Required) Type of folder. 'Folder' or 'Program'. Default is 'Folder' (This can only be one of Folder,Program)", "type": "text/plain" }, "key": "type", "value": "Program" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Id of the folder to retrieve", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "bec513de-46dd-4cc1-898b-f56b1c174d17", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "folder", ":id", "content.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of records to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": false, "description": { "content": "(Required) Type of folder. 'Folder' or 'Program'. Default is 'Folder' (This can only be one of Folder,Program)", "type": "text/plain" }, "key": "type", "value": "Program" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the folder to retrieve", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "39501557-d950-4126-9cbd-9c3836bc8800", "name": "Delete Folder", "request": { "name": "Delete Folder", "description": { "content": "Deletes the designated folder. Deletion will fail if the folder has content. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "folder", ":id", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Id of the folder to delete", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) type", "type": "text/plain" }, "key": "type", "value": "Folder" } ] }, "auth": null }, "response": [ { "id": "feea112b-0e3d-47d4-af7b-e4bd63da7459", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "folder", ":id", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the folder to delete", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) type", "type": "text/plain" }, "key": "type", "value": "Folder" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cf305450-a1cf-4a2b-8824-2f2c70ed7881", "name": "Get Folders", "request": { "name": "Get Folders", "description": { "content": "Retrieves child folders from within a given root folder. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "folders.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Parent folder reference", "type": "text/plain" }, "key": "root", "value": "" }, { "disabled": true, "description": { "content": "Maximum folder depth to traverse, Default 2", "type": "text/plain" }, "key": "maxDepth", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of folders to return. Default 20, maximum 200", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging. Default 0", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Name of the workspace", "type": "text/plain" }, "key": "workSpace", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ec08bff6-005d-4083-b63c-d00c2c9d26ee", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "folders.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Parent folder reference", "type": "text/plain" }, "key": "root", "value": "" }, { "disabled": true, "description": { "content": "Maximum folder depth to traverse, Default 2", "type": "text/plain" }, "key": "maxDepth", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of folders to return. Default 20, maximum 200", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging. Default 0", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Name of the workspace", "type": "text/plain" }, "key": "workSpace", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"createdAt\": \"\",\n \"folderId\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"folderType\": \"Landing Page Form\",\n \"id\": \"\",\n \"isArchive\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"path\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"accessZoneId\": \"\",\n \"description\": \"\",\n \"isSystem\": \"\",\n \"workspace\": \"\"\n },\n {\n \"createdAt\": \"\",\n \"folderId\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"folderType\": \"Email\",\n \"id\": \"\",\n \"isArchive\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"path\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"accessZoneId\": \"\",\n \"description\": \"\",\n \"isSystem\": \"\",\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d6fe95a0-8a0b-43b1-8014-0b63417588a9", "name": "Create Folder", "request": { "name": "Create Folder", "description": { "content": "Creates a new folder. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "folders.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Name of the Folder", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": false, "description": { "content": "(Required) Folder object describing the parent folder", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) Folder object describing the parent folder", "type": "text/plain" }, "key": "type", "value": "Program" }, { "disabled": true, "description": { "content": "Description of the asset", "type": "text/plain" }, "key": "description", "value": "" } ] }, "auth": null }, "response": [ { "id": "08b96365-48ba-4f86-b7ca-2f939ca21dca", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "folders.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Name of the Folder", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": false, "description": { "content": "(Required) Folder object describing the parent folder", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) Folder object describing the parent folder", "type": "text/plain" }, "key": "type", "value": "Program" }, { "disabled": true, "description": { "content": "Description of the asset", "type": "text/plain" }, "key": "description", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"createdAt\": \"\",\n \"folderId\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"folderType\": \"Landing Page Form\",\n \"id\": \"\",\n \"isArchive\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"path\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"accessZoneId\": \"\",\n \"description\": \"\",\n \"isSystem\": \"\",\n \"workspace\": \"\"\n },\n {\n \"createdAt\": \"\",\n \"folderId\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"folderType\": \"Email\",\n \"id\": \"\",\n \"isArchive\": \"\",\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"path\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"accessZoneId\": \"\",\n \"description\": \"\",\n \"isSystem\": \"\",\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Files", "description": "Upload and manage files in Design Studio, and read their metadata.", "item": [ { "id": "4560b8fa-d390-4ced-af21-990d1bb892a1", "name": "Get File by Name", "request": { "name": "Get File by Name", "description": { "content": "Returns files records for the given name. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "file", "byName.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Name of the file", "type": "text/plain" }, "key": "name", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c59f3e53-8459-46c5-a02d-c2ce6c43f5a9", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "file", "byName.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Name of the file", "type": "text/plain" }, "key": "name", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"createdAt\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n \"id\": \"\",\n \"mimeType\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"description\": \"\"\n },\n {\n \"createdAt\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n \"id\": \"\",\n \"mimeType\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"description\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aaa0a149-e4b4-45fd-b11b-aef111cfa475", "name": "Get File by Id", "request": { "name": "Get File by Id", "description": { "content": "Returns the file record for the given id. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "file", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6054ab92-a3ce-40bf-b829-a09a311b5660", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "file", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"createdAt\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n \"id\": \"\",\n \"mimeType\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"description\": \"\"\n },\n {\n \"createdAt\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n \"id\": \"\",\n \"mimeType\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"description\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3d22498b-53df-4485-bbb7-1c4c7e570c39", "name": "Get Files", "request": { "name": "Get Files", "description": { "content": "Returns the files from the given folder. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "files.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "folder", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging. Default 0", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of files to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3f68860f-5da4-4843-925d-cb335a71a645", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "files.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "folder", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging. Default 0", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of files to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"createdAt\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n \"id\": \"\",\n \"mimeType\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"description\": \"\"\n },\n {\n \"createdAt\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n \"id\": \"\",\n \"mimeType\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"description\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8ac5d1d7-7005-4d68-8ac2-b9e63a1c9d41", "name": "Create File", "request": { "name": "Create File", "description": { "content": "Creates a new file from the included payload. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "files.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Multipart file. Content of the file.", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "folder", "value": "[object Object]", "type": "text" }, { "description": { "content": "(Required) Name of the File", "type": "text/plain" }, "key": "name", "value": "", "type": "text" }, { "description": { "content": "Description of the asset", "type": "text/plain" }, "key": "description", "value": "", "type": "text" }, { "description": { "content": "Whether the calls hould fail if there is already an existing file with the same name", "type": "text/plain" }, "key": "insertOnly", "value": "", "type": "text" } ] }, "auth": null }, "response": [ { "id": "5611ea23-d0dd-486e-a557-ba95dc305ded", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "files.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Multipart file. Content of the file.", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "folder", "value": "[object Object]", "type": "text" }, { "description": { "content": "(Required) Name of the File", "type": "text/plain" }, "key": "name", "value": "", "type": "text" }, { "description": { "content": "Description of the asset", "type": "text/plain" }, "key": "description", "value": "", "type": "text" }, { "description": { "content": "Whether the calls hould fail if there is already an existing file with the same name", "type": "text/plain" }, "key": "insertOnly", "value": "", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"createdAt\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n \"id\": \"\",\n \"mimeType\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"description\": \"\"\n },\n {\n \"createdAt\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n \"id\": \"\",\n \"mimeType\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"description\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "File Contents", "description": "Retrieve the raw byte content of a file asset.", "item": [ { "id": "e5a9d30e-f959-4e6d-82c2-d8dc5fe8b32e", "name": "Update File Content", "request": { "name": "Update File Content", "description": { "content": "Replaces the current content of the file with the included payload. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "file", ":id", "content.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Id for file in database", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Multipart file. Content of the file.", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "(Required) Id of the file", "type": "text/plain" }, "key": "id", "value": "", "type": "text" } ] }, "auth": null }, "response": [ { "id": "23d59545-3a3d-456b-96d5-bd57991aced6", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "file", ":id", "content.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id for file in database", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Multipart file. Content of the file.", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "(Required) Id of the file", "type": "text/plain" }, "key": "id", "value": "", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"createdAt\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n \"id\": \"\",\n \"mimeType\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"description\": \"\"\n },\n {\n \"createdAt\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n \"id\": \"\",\n \"mimeType\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"description\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Emails", "description": "CRUD operations on classic emails, plus content, variables, dynamic content, approval, and send-sample.", "item": [ { "id": "5f894c33-7855-4f52-abf5-80e4abb5bd7c", "name": "Get Email by Name", "request": { "name": "Get Email by Name", "description": { "content": "Returns email records based on the given name. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "email", "byName.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Name of the email", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" }, { "disabled": true, "description": { "content": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "folder", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b4e81de8-f94f-4739-aabb-769a5091d512", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "email", "byName.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Name of the email", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" }, { "disabled": true, "description": { "content": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "folder", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"fromEmail\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"fromName\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"operational\": \"\",\n \"publishToMSI\": \"\",\n \"replyEmail\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"status\": \"\",\n \"subject\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"template\": \"\",\n \"textOnly\": \"\",\n \"webView\": \"\",\n \"autoCopyToText\": \"\",\n \"preHeader\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"version\": 2,\n \"workspace\": \"\",\n \"ccFields\": [\n {\n \"attributeId\": \"\",\n \"objectName\": \"\",\n \"displayName\": \"\",\n \"apiName\": \"\"\n },\n {\n \"attributeId\": \"\",\n \"objectName\": \"\",\n \"displayName\": \"\",\n \"apiName\": \"\"\n }\n ]\n },\n {\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"fromEmail\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"fromName\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"operational\": \"\",\n \"publishToMSI\": \"\",\n \"replyEmail\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"status\": \"\",\n \"subject\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"template\": \"\",\n \"textOnly\": \"\",\n \"webView\": \"\",\n \"autoCopyToText\": \"\",\n \"preHeader\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"version\": 2,\n \"workspace\": \"\",\n \"ccFields\": [\n {\n \"attributeId\": \"\",\n \"objectName\": \"\",\n \"displayName\": \"\",\n \"apiName\": \"\"\n },\n {\n \"attributeId\": \"\",\n \"objectName\": \"\",\n \"displayName\": \"\",\n \"apiName\": \"\"\n }\n ]\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eff89a53-99c7-4c07-8a2e-d81c2fd00af5", "name": "Get Email CC Fields", "request": { "name": "Get Email CC Fields", "description": { "content": "Returns the set of fields enabled for Email CC in the target instance. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "email", "ccFields.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a25356b6-001a-49b7-8458-f7d3356fe548", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "email", "ccFields.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"attributeId\": \"\",\n \"objectName\": \"\",\n \"displayName\": \"\",\n \"apiName\": \"\"\n },\n {\n \"attributeId\": \"\",\n \"objectName\": \"\",\n \"displayName\": \"\",\n \"apiName\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "989281d6-906d-43ab-a9b4-dad6787bb785", "name": "Get Email By Id", "request": { "name": "Get Email By Id", "description": { "content": "Returns an email record by its id. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "email", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d7e804d5-35f8-4899-b133-8857b83a4f50", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "email", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"fromEmail\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"fromName\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"operational\": \"\",\n \"publishToMSI\": \"\",\n \"replyEmail\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"status\": \"\",\n \"subject\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"template\": \"\",\n \"textOnly\": \"\",\n \"webView\": \"\",\n \"autoCopyToText\": \"\",\n \"preHeader\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"version\": 2,\n \"workspace\": \"\",\n \"ccFields\": [\n {\n \"attributeId\": \"\",\n \"objectName\": \"\",\n \"displayName\": \"\",\n \"apiName\": \"\"\n },\n {\n \"attributeId\": \"\",\n \"objectName\": \"\",\n \"displayName\": \"\",\n \"apiName\": \"\"\n }\n ]\n },\n {\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"fromEmail\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"fromName\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"operational\": \"\",\n \"publishToMSI\": \"\",\n \"replyEmail\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"status\": \"\",\n \"subject\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"template\": \"\",\n \"textOnly\": \"\",\n \"webView\": \"\",\n \"autoCopyToText\": \"\",\n \"preHeader\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"version\": 2,\n \"workspace\": \"\",\n \"ccFields\": [\n {\n \"attributeId\": \"\",\n \"objectName\": \"\",\n \"displayName\": \"\",\n \"apiName\": \"\"\n },\n {\n \"attributeId\": \"\",\n \"objectName\": \"\",\n \"displayName\": \"\",\n \"apiName\": \"\"\n }\n ]\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f659d6d6-f585-4d89-9cb9-0d966e102197", "name": "Update Email Metadata", "request": { "name": "Update Email Metadata", "description": { "content": "Updates the metadata of an email asset. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "email", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "Description of the asset", "type": "text/plain" }, "key": "description", "value": "" }, { "disabled": true, "description": { "content": "Name of the Email", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Preheader text for the email", "type": "text/plain" }, "key": "preHeader", "value": "" }, { "disabled": true, "description": { "content": "Whether the email is operational. Operational emails bypass unsubscribe status. Defaults to false", "type": "text/plain" }, "key": "operational", "value": "" }, { "disabled": true, "description": { "content": "Whether the email has been published to Sales Insight. Default false", "type": "text/plain" }, "key": "published", "value": "" }, { "disabled": true, "description": { "content": "Setting to include text-only version of email when sent", "type": "text/plain" }, "key": "textOnly", "value": "" }, { "disabled": true, "description": { "content": "Whether the email has been enabled to allow the 'View as Web Page' when received", "type": "text/plain" }, "key": "webView", "value": "" }, { "disabled": true, "description": { "content": "Setting to automatically copy HTML version to Text version", "type": "text/plain" }, "key": "autoCopyToText", "value": "" } ] }, "auth": null }, "response": [ { "id": "67f6b9f3-627e-4091-8154-c78a4c32934e", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "email", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "Description of the asset", "type": "text/plain" }, "key": "description", "value": "" }, { "disabled": true, "description": { "content": "Name of the Email", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Preheader text for the email", "type": "text/plain" }, "key": "preHeader", "value": "" }, { "disabled": true, "description": { "content": "Whether the email is operational. Operational emails bypass unsubscribe status. Defaults to false", "type": "text/plain" }, "key": "operational", "value": "" }, { "disabled": true, "description": { "content": "Whether the email has been published to Sales Insight. Default false", "type": "text/plain" }, "key": "published", "value": "" }, { "disabled": true, "description": { "content": "Setting to include text-only version of email when sent", "type": "text/plain" }, "key": "textOnly", "value": "" }, { "disabled": true, "description": { "content": "Whether the email has been enabled to allow the 'View as Web Page' when received", "type": "text/plain" }, "key": "webView", "value": "" }, { "disabled": true, "description": { "content": "Setting to automatically copy HTML version to Text version", "type": "text/plain" }, "key": "autoCopyToText", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"fromEmail\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"fromName\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"operational\": \"\",\n \"publishToMSI\": \"\",\n \"replyEmail\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"status\": \"\",\n \"subject\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"template\": \"\",\n \"textOnly\": \"\",\n \"webView\": \"\",\n \"autoCopyToText\": \"\",\n \"preHeader\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"version\": 2,\n \"workspace\": \"\",\n \"ccFields\": [\n {\n \"attributeId\": \"\",\n \"objectName\": \"\",\n \"displayName\": \"\",\n \"apiName\": \"\"\n },\n {\n \"attributeId\": \"\",\n \"objectName\": \"\",\n \"displayName\": \"\",\n \"apiName\": \"\"\n }\n ]\n },\n {\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"fromEmail\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"fromName\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"operational\": \"\",\n \"publishToMSI\": \"\",\n \"replyEmail\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"status\": \"\",\n \"subject\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"template\": \"\",\n \"textOnly\": \"\",\n \"webView\": \"\",\n \"autoCopyToText\": \"\",\n \"preHeader\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"version\": 2,\n \"workspace\": \"\",\n \"ccFields\": [\n {\n \"attributeId\": \"\",\n \"objectName\": \"\",\n \"displayName\": \"\",\n \"apiName\": \"\"\n },\n {\n \"attributeId\": \"\",\n \"objectName\": \"\",\n \"displayName\": \"\",\n \"apiName\": \"\"\n }\n ]\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5943c9cb-79bb-4760-a5a4-288b6a6edcbe", "name": "Approve Email Draft", "request": { "name": "Approve Email Draft", "description": { "content": "Approves the current draft of an email. Required Permissions: Approve Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "email", ":id", "approveDraft.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "74da50d5-6862-49da-9d55-6e0b9f71508f", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "email", ":id", "approveDraft.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e371d322-b9ed-46fd-a230-9993c333d089", "name": "Clone Email", "request": { "name": "Clone Email", "description": { "content": "Clones the target email. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "email", ":id", "clone.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "type", "value": "Program" }, { "disabled": false, "description": { "content": "(Required) Name of the new email asset", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Description of the asset", "type": "text/plain" }, "key": "description", "value": "" }, { "disabled": true, "description": { "content": "Whether the email is operational. Operational emails bypass unsubscribe status. Defaults to false", "type": "text/plain" }, "key": "operational", "value": "" } ] }, "auth": null }, "response": [ { "id": "a6c56097-6b83-439b-945e-f889d16298c0", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "email", ":id", "clone.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "type", "value": "Program" }, { "disabled": false, "description": { "content": "(Required) Name of the new email asset", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Description of the asset", "type": "text/plain" }, "key": "description", "value": "" }, { "disabled": true, "description": { "content": "Whether the email is operational. Operational emails bypass unsubscribe status. Defaults to false", "type": "text/plain" }, "key": "operational", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"fromEmail\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"fromName\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"operational\": \"\",\n \"publishToMSI\": \"\",\n \"replyEmail\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"status\": \"\",\n \"subject\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"template\": \"\",\n \"textOnly\": \"\",\n \"webView\": \"\",\n \"autoCopyToText\": \"\",\n \"preHeader\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"version\": 2,\n \"workspace\": \"\",\n \"ccFields\": [\n {\n \"attributeId\": \"\",\n \"objectName\": \"\",\n \"displayName\": \"\",\n \"apiName\": \"\"\n },\n {\n \"attributeId\": \"\",\n \"objectName\": \"\",\n \"displayName\": \"\",\n \"apiName\": \"\"\n }\n ]\n },\n {\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"fromEmail\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"fromName\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"operational\": \"\",\n \"publishToMSI\": \"\",\n \"replyEmail\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"status\": \"\",\n \"subject\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"template\": \"\",\n \"textOnly\": \"\",\n \"webView\": \"\",\n \"autoCopyToText\": \"\",\n \"preHeader\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"version\": 2,\n \"workspace\": \"\",\n \"ccFields\": [\n {\n \"attributeId\": \"\",\n \"objectName\": \"\",\n \"displayName\": \"\",\n \"apiName\": \"\"\n },\n {\n \"attributeId\": \"\",\n \"objectName\": \"\",\n \"displayName\": \"\",\n \"apiName\": \"\"\n }\n ]\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d4b737ce-5deb-45ef-a428-9093b22baddf", "name": "Get Email Content", "request": { "name": "Get Email Content", "description": { "content": "Returns the content of the designated email. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "email", ":id", "content.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e3090f92-1e6a-43e2-8a29-21997d205c50", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "email", ":id", "content.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"contentType\": \"\",\n \"htmlId\": \"\",\n \"value\": {},\n \"index\": \"\",\n \"isLocked\": \"\",\n \"parentHtmlId\": \"\"\n },\n {\n \"contentType\": \"\",\n \"htmlId\": \"\",\n \"value\": {},\n \"index\": \"\",\n \"isLocked\": \"\",\n \"parentHtmlId\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d853d382-dd90-4a2f-ba10-87f9dbfce927", "name": "Update Email Content", "request": { "name": "Update Email Content", "description": { "content": "Updates the content of an email. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "email", ":id", "content.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "From-address of the Email", "type": "text/plain" }, "key": "type", "value": "" }, { "disabled": true, "description": { "content": "From-address of the Email", "type": "text/plain" }, "key": "value", "value": "" }, { "disabled": true, "description": { "content": "From-name of the Email", "type": "text/plain" }, "key": "type", "value": "" }, { "disabled": true, "description": { "content": "From-name of the Email", "type": "text/plain" }, "key": "value", "value": "" }, { "disabled": true, "description": { "content": "Reply-To address of the Email", "type": "text/plain" }, "key": "type", "value": "" }, { "disabled": true, "description": { "content": "Reply-To address of the Email", "type": "text/plain" }, "key": "value", "value": "" }, { "disabled": true, "description": { "content": "Subject Line of the Email", "type": "text/plain" }, "key": "type", "value": "" }, { "disabled": true, "description": { "content": "Subject Line of the Email", "type": "text/plain" }, "key": "value", "value": "" } ] }, "auth": null }, "response": [ { "id": "0f9153cc-2858-4a72-9390-8f9379f0f891", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "email", ":id", "content.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "From-address of the Email", "type": "text/plain" }, "key": "type", "value": "" }, { "disabled": true, "description": { "content": "From-address of the Email", "type": "text/plain" }, "key": "value", "value": "" }, { "disabled": true, "description": { "content": "From-name of the Email", "type": "text/plain" }, "key": "type", "value": "" }, { "disabled": true, "description": { "content": "From-name of the Email", "type": "text/plain" }, "key": "value", "value": "" }, { "disabled": true, "description": { "content": "Reply-To address of the Email", "type": "text/plain" }, "key": "type", "value": "" }, { "disabled": true, "description": { "content": "Reply-To address of the Email", "type": "text/plain" }, "key": "value", "value": "" }, { "disabled": true, "description": { "content": "Subject Line of the Email", "type": "text/plain" }, "key": "type", "value": "" }, { "disabled": true, "description": { "content": "Subject Line of the Email", "type": "text/plain" }, "key": "value", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "accd78cc-91b5-4f0e-9b87-747dba4e27d5", "name": "Rearrange Email Modules", "request": { "name": "Rearrange Email Modules", "description": { "content": "Rearranges the modules in an email. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "email", ":id", "content", "rearrange.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "0", "value": "<" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "1", "value": "s" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "2", "value": "t" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "3", "value": "r" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "4", "value": "i" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "5", "value": "n" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "6", "value": "g" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "7", "value": ">" } ] }, "auth": null }, "response": [ { "id": "8f0ec2d0-7043-4116-aba7-5185109689d9", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "email", ":id", "content", "rearrange.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "0", "value": "<" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "1", "value": "s" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "2", "value": "t" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "3", "value": "r" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "4", "value": "i" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "5", "value": "n" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "6", "value": "g" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "7", "value": ">" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3476d56e-7598-4f85-ae7b-93b080f7fae8", "name": "Update Email Content Section", "request": { "name": "Update Email Content Section", "description": { "content": "Updates the content in the given section. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "email", ":id", "content", "{{htmlId}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Type of content to set for the section.", "type": "text/plain" }, "key": "type", "value": "DynamicContent" }, { "disabled": false, "description": { "content": "(Required) 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", "type": "text/plain" }, "key": "value", "value": "" }, { "disabled": true, "description": { "content": "Sets the value of the alt parameter for the resulting img element", "type": "text/plain" }, "key": "altText", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "externalUrl", "value": "" }, { "disabled": true, "description": { "content": "Overrides naitve height of the image. The resulting file will be resized to the given height", "type": "text/plain" }, "key": "height", "value": "" }, { "disabled": true, "description": { "content": "Multipart file that allows you to load an image from your computer", "type": "text/plain" }, "key": "image", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "linkUrl", "value": "" }, { "disabled": true, "description": { "content": "Allows overwriting of the existing image content section", "type": "text/plain" }, "key": "overWrite", "value": "" }, { "disabled": true, "description": { "content": "Sets the value of the style parameter for the content section", "type": "text/plain" }, "key": "style", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "textValue", "value": "" }, { "disabled": true, "description": { "content": "Sets the Url of the video element. Videos must be either from YouTube or Vimeo", "type": "text/plain" }, "key": "videoUrl", "value": "" }, { "disabled": true, "description": { "content": "Overrides native width of the image. The resulting file will be resized to the given width", "type": "text/plain" }, "key": "width", "value": "" } ] }, "auth": null }, "response": [ { "id": "6221425b-cb49-4812-9079-c9aaaee0ff7c", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "email", ":id", "content", "{{htmlId}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Type of content to set for the section.", "type": "text/plain" }, "key": "type", "value": "DynamicContent" }, { "disabled": false, "description": { "content": "(Required) 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", "type": "text/plain" }, "key": "value", "value": "" }, { "disabled": true, "description": { "content": "Sets the value of the alt parameter for the resulting img element", "type": "text/plain" }, "key": "altText", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "externalUrl", "value": "" }, { "disabled": true, "description": { "content": "Overrides naitve height of the image. The resulting file will be resized to the given height", "type": "text/plain" }, "key": "height", "value": "" }, { "disabled": true, "description": { "content": "Multipart file that allows you to load an image from your computer", "type": "text/plain" }, "key": "image", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "linkUrl", "value": "" }, { "disabled": true, "description": { "content": "Allows overwriting of the existing image content section", "type": "text/plain" }, "key": "overWrite", "value": "" }, { "disabled": true, "description": { "content": "Sets the value of the style parameter for the content section", "type": "text/plain" }, "key": "style", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "textValue", "value": "" }, { "disabled": true, "description": { "content": "Sets the Url of the video element. Videos must be either from YouTube or Vimeo", "type": "text/plain" }, "key": "videoUrl", "value": "" }, { "disabled": true, "description": { "content": "Overrides native width of the image. The resulting file will be resized to the given width", "type": "text/plain" }, "key": "width", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "21d5d6c5-e44f-4a2a-91ca-e796fc559e3c", "name": "Add Email Module", "request": { "name": "Add Email Module", "description": { "content": "Adds a new module to an email, with the given id. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "email", ":id", "content", ":moduleId", "add.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Name of the module", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": false, "description": { "content": "(Required) Index of the module. Determines the order of the module in the email.", "type": "text/plain" }, "key": "index", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } }, { "type": "any", "value": "", "key": "moduleId", "disabled": false, "description": { "content": "(Required) moduleId", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "312894eb-e838-4e49-83d5-33c8d725fa82", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "email", ":id", "content", ":moduleId", "add.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Name of the module", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": false, "description": { "content": "(Required) Index of the module. Determines the order of the module in the email.", "type": "text/plain" }, "key": "index", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) moduleId", "type": "text/plain" }, "type": "any", "value": "", "key": "moduleId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "169ac9f6-0077-4fcc-9030-6835ea10b24a", "name": "Delete Module", "request": { "name": "Delete Module", "description": { "content": "Deletes the given module from the email. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "email", ":id", "content", ":moduleId", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } }, { "type": "any", "value": "", "key": "moduleId", "disabled": false, "description": { "content": "(Required) moduleId", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "7c9d59cf-970a-4869-a58a-63d31878b2cb", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "email", ":id", "content", ":moduleId", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) moduleId", "type": "text/plain" }, "type": "any", "value": "", "key": "moduleId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6959a0a4-cafa-4f68-8843-ed1f468ac6a5", "name": "Duplicate Email Module", "request": { "name": "Duplicate Email Module", "description": { "content": "Creates a copy of the designated module in an email. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "email", ":id", "content", ":moduleId", "duplicate.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Name of the new module", "type": "text/plain" }, "key": "name", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } }, { "type": "any", "value": "", "key": "moduleId", "disabled": false, "description": { "content": "(Required) moduleId", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "6ed5fa8c-99ca-4aa5-95ac-a7f8c7db7154", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "email", ":id", "content", ":moduleId", "duplicate.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Name of the new module", "type": "text/plain" }, "key": "name", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) moduleId", "type": "text/plain" }, "type": "any", "value": "", "key": "moduleId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "afe95927-becb-40a8-ba85-eadf600db6f0", "name": "Rename Email Module", "request": { "name": "Rename Email Module", "description": { "content": "Renames a module. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "email", ":id", "content", ":moduleId", "rename.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) New module name", "type": "text/plain" }, "key": "name", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } }, { "type": "any", "value": "", "key": "moduleId", "disabled": false, "description": { "content": "(Required) moduleId", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "b4f4d798-89ab-4a9c-b42a-26d4de958167", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "email", ":id", "content", ":moduleId", "rename.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) New module name", "type": "text/plain" }, "key": "name", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) moduleId", "type": "text/plain" }, "type": "any", "value": "", "key": "moduleId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e7c8f6fe-ca3a-49b1-b325-19f7225e776d", "name": "Delete Email", "request": { "name": "Delete Email", "description": { "content": "Deletes the target email. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "email", ":id", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "5084aa8a-c9cc-4f55-a96f-925b50e2a5e5", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "email", ":id", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9b744db3-c57f-4a0a-97d6-c593523966b5", "name": "Discard Email Draft", "request": { "name": "Discard Email Draft", "description": { "content": "Discards the current draft of an email. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "email", ":id", "discardDraft.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "c8920bec-2fda-4193-8552-d10528ed5001", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "email", ":id", "discardDraft.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "671ac9c4-bdd8-41ed-92c6-454b73e21b7f", "name": "Get Email Dynamic Content", "request": { "name": "Get Email Dynamic Content", "description": { "content": "Retrieves the dynamic content record for the given section. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "email", ":id", "dynamicContent", "{{contentId}}.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Id of email", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "7fec54e2-ab4f-48a8-979d-43648fdb635a", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "email", ":id", "dynamicContent", "{{contentId}}.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of email", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"content\": [\n {\n \"content\": \"\",\n \"id\": \"\",\n \"segmentId\": \"\",\n \"segmentName\": \"\",\n \"type\": \"\"\n },\n {\n \"content\": \"\",\n \"id\": \"\",\n \"segmentId\": \"\",\n \"segmentName\": \"\",\n \"type\": \"\"\n }\n ],\n \"createdAt\": \"\",\n \"id\": \"\",\n \"segmentation\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"content\": [\n {\n \"content\": \"\",\n \"id\": \"\",\n \"segmentId\": \"\",\n \"segmentName\": \"\",\n \"type\": \"\"\n },\n {\n \"content\": \"\",\n \"id\": \"\",\n \"segmentId\": \"\",\n \"segmentName\": \"\",\n \"type\": \"\"\n }\n ],\n \"createdAt\": \"\",\n \"id\": \"\",\n \"segmentation\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ad9139da-781d-466a-99a7-7240fd397373", "name": "Update Email Dynamic Content Section", "request": { "name": "Update Email Dynamic Content Section", "description": { "content": "Updates dynamic content in the given section. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "email", ":id", "dynamicContent", "{{contentId}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Id of email", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Type of content to set for the section.", "type": "text/plain" }, "key": "type", "value": "Snippet" }, { "disabled": false, "description": { "content": "(Required) 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", "type": "text/plain" }, "key": "value", "value": "" }, { "disabled": true, "description": { "content": "Sets the value of the alt parameter for the resulting img element", "type": "text/plain" }, "key": "altText", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "externalUrl", "value": "" }, { "disabled": true, "description": { "content": "Overrides naitve height of the image. The resulting file will be resized to the given height", "type": "text/plain" }, "key": "height", "value": "" }, { "disabled": true, "description": { "content": "Multipart file that allows you to add an image from your computer", "type": "text/plain" }, "key": "image", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "linkUrl", "value": "" }, { "disabled": true, "description": { "content": "Allows overwriting of the existing image content section", "type": "text/plain" }, "key": "overWrite", "value": "" }, { "disabled": true, "description": { "content": "Sets the value of the style parameter for the content section", "type": "text/plain" }, "key": "style", "value": "" }, { "disabled": true, "description": { "content": "Sets the Url of the video element. Videos must be either from YouTube or Vimeo", "type": "text/plain" }, "key": "videoUrl", "value": "" }, { "disabled": true, "description": { "content": "Overrides native width of the image. The resulting file will be resized to the given width", "type": "text/plain" }, "key": "width", "value": "" } ] }, "auth": null }, "response": [ { "id": "6ef8a311-ad07-49a0-82a1-da898a3b337b", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "email", ":id", "dynamicContent", "{{contentId}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of email", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Type of content to set for the section.", "type": "text/plain" }, "key": "type", "value": "Snippet" }, { "disabled": false, "description": { "content": "(Required) 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", "type": "text/plain" }, "key": "value", "value": "" }, { "disabled": true, "description": { "content": "Sets the value of the alt parameter for the resulting img element", "type": "text/plain" }, "key": "altText", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "externalUrl", "value": "" }, { "disabled": true, "description": { "content": "Overrides naitve height of the image. The resulting file will be resized to the given height", "type": "text/plain" }, "key": "height", "value": "" }, { "disabled": true, "description": { "content": "Multipart file that allows you to add an image from your computer", "type": "text/plain" }, "key": "image", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "linkUrl", "value": "" }, { "disabled": true, "description": { "content": "Allows overwriting of the existing image content section", "type": "text/plain" }, "key": "overWrite", "value": "" }, { "disabled": true, "description": { "content": "Sets the value of the style parameter for the content section", "type": "text/plain" }, "key": "style", "value": "" }, { "disabled": true, "description": { "content": "Sets the Url of the video element. Videos must be either from YouTube or Vimeo", "type": "text/plain" }, "key": "videoUrl", "value": "" }, { "disabled": true, "description": { "content": "Overrides native width of the image. The resulting file will be resized to the given width", "type": "text/plain" }, "key": "width", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "637f6991-5791-4b55-b29c-ef188bf5ff6a", "name": "Get Email Full Content", "request": { "name": "Get Email Full Content", "description": { "content": "Returns the serialized HTML version of the email. Required Permissions: Read-Only Assets, Read-Write Assets. If leadId is passed in the request: Read-Only Lead, Read-Write Lead.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "email", ":id", "fullContent.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions. Defaults to approved if asset is approved, draft if not. (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" }, { "disabled": true, "description": { "content": "The lead id to impersonate. Email is rendered as though it was received by this lead.", "type": "text/plain" }, "key": "leadId", "value": "" }, { "disabled": true, "description": { "content": "Email content type to return. Default is HTML. (This can only be one of Text,HTML)", "type": "text/plain" }, "key": "type", "value": "Text" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Id of the email", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "379504aa-62c8-4e99-9c7a-c697b44b8143", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "email", ":id", "fullContent.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions. Defaults to approved if asset is approved, draft if not. (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" }, { "disabled": true, "description": { "content": "The lead id to impersonate. Email is rendered as though it was received by this lead.", "type": "text/plain" }, "key": "leadId", "value": "" }, { "disabled": true, "description": { "content": "Email content type to return. Default is HTML. (This can only be one of Text,HTML)", "type": "text/plain" }, "key": "type", "value": "Text" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the email", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"content\": \"\",\n \"id\": \"\",\n \"status\": \"draft\"\n },\n {\n \"content\": \"\",\n \"id\": \"\",\n \"status\": \"draft\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0ea0d37c-d9fc-4802-9d50-862aa0656fc1", "name": "Update Email Full Content", "request": { "name": "Update Email Full Content", "description": { "content": "Replaces the HTML of an Email that has had its relationship broken from its template. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "email", ":id", "fullContent.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Id of the email", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Multipart file. File containing HTML document to update with. File cannot include JavaScript or script tags.", "type": "text/plain" }, "key": "content", "value": "", "type": "text" } ] }, "auth": null }, "response": [ { "id": "97827ea2-9181-483d-bf6d-a195c622f634", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "email", ":id", "fullContent.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the email", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Multipart file. File containing HTML document to update with. File cannot include JavaScript or script tags.", "type": "text/plain" }, "key": "content", "value": "", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "93d8ecbc-b29e-43a7-b300-91311391be1c", "name": "Send Sample Email", "request": { "name": "Send Sample Email", "description": { "content": "Sends a sample email to the given email address. Leads may be impersonated to populate data for tokens and dynamic content. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "email", ":id", "sendSample.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Id of the email", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Email address to receive sample email", "type": "text/plain" }, "key": "emailAddress", "value": "" }, { "disabled": true, "description": { "content": "Id of a lead to impersonate. Tokens and dynamic content will be populated as though it were sent to the lead.", "type": "text/plain" }, "key": "leadId", "value": "" }, { "disabled": true, "description": { "content": "Whether to send to text only version along with the HTML version. Default false.", "type": "text/plain" }, "key": "textOnly", "value": "" } ] }, "auth": null }, "response": [ { "id": "30b451e3-2c6c-42a4-a68e-6c22cb18fa21", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "email", ":id", "sendSample.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the email", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Email address to receive sample email", "type": "text/plain" }, "key": "emailAddress", "value": "" }, { "disabled": true, "description": { "content": "Id of a lead to impersonate. Tokens and dynamic content will be populated as though it were sent to the lead.", "type": "text/plain" }, "key": "leadId", "value": "" }, { "disabled": true, "description": { "content": "Whether to send to text only version along with the HTML version. Default false.", "type": "text/plain" }, "key": "textOnly", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"service\": \"sendTestEmail\",\n \"result\": \"\"\n },\n {\n \"service\": \"sendTestEmail\",\n \"result\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "283ff765-104d-4d20-8d06-e43db1458d4c", "name": "Unapprove Email", "request": { "name": "Unapprove Email", "description": { "content": "Unapproves the email and reverts it to a draft-only state. Required Permissions: Approve Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "email", ":id", "unapprove.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "d5f69c3c-e1f8-412c-a2f7-51681eb26e29", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "email", ":id", "unapprove.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b8d5549d-03f1-45f4-925c-7a576550a838", "name": "Update Email Variable", "request": { "name": "Update Email Variable", "description": { "content": "Updates the value of a given variable in an email. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "email", ":id", "variable", "{{name}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "Value to update variable with", "type": "text/plain" }, "key": "value", "value": "" }, { "disabled": true, "description": { "content": "Module that variable is associated with. Required for updating module variables. Not needed for global variables.", "type": "text/plain" }, "key": "moduleId", "value": "" } ] }, "auth": null }, "response": [ { "id": "f0045a52-a70b-4b17-a540-0be877b13307", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "email", ":id", "variable", "{{name}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "Value to update variable with", "type": "text/plain" }, "key": "value", "value": "" }, { "disabled": true, "description": { "content": "Module that variable is associated with. Required for updating module variables. Not needed for global variables.", "type": "text/plain" }, "key": "moduleId", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"moduleScope\": \"\",\n \"moduleId\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"moduleScope\": \"\",\n \"moduleId\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6265026c-0766-40af-bb14-e3eda31a25fe", "name": "Get Email Variables", "request": { "name": "Get Email Variables", "description": { "content": "Returns a list of the available variables in an email. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "email", ":id", "variables.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "24e9432e-14fb-4f90-8913-c88b1c456192", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "email", ":id", "variables.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"moduleScope\": \"\",\n \"moduleId\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"moduleScope\": \"\",\n \"moduleId\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dc0635d6-2e5a-4ca2-9877-fe40fcfdc228", "name": "Get Emails", "request": { "name": "Get Emails", "description": { "content": "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 endpoint.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "emails.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" }, { "disabled": true, "description": { "content": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "folder", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of emails to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Exclude emails prior to this date. Must be valid ISO-8601 string. See Datetime field type description.", "type": "text/plain" }, "key": "earliestUpdatedAt", "value": "" }, { "disabled": true, "description": { "content": "Exclude emails after this date. Must be valid ISO-8601 string. See Datetime field type description.", "type": "text/plain" }, "key": "latestUpdatedAt", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "75763334-9f72-46b4-9f53-674e09d5b665", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "emails.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" }, { "disabled": true, "description": { "content": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "folder", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of emails to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Exclude emails prior to this date. Must be valid ISO-8601 string. See Datetime field type description.", "type": "text/plain" }, "key": "earliestUpdatedAt", "value": "" }, { "disabled": true, "description": { "content": "Exclude emails after this date. Must be valid ISO-8601 string. See Datetime field type description.", "type": "text/plain" }, "key": "latestUpdatedAt", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"fromEmail\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"fromName\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"operational\": \"\",\n \"publishToMSI\": \"\",\n \"replyEmail\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"status\": \"\",\n \"subject\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"template\": \"\",\n \"textOnly\": \"\",\n \"webView\": \"\",\n \"autoCopyToText\": \"\",\n \"preHeader\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"version\": 2,\n \"workspace\": \"\",\n \"ccFields\": [\n {\n \"attributeId\": \"\",\n \"objectName\": \"\",\n \"displayName\": \"\",\n \"apiName\": \"\"\n },\n {\n \"attributeId\": \"\",\n \"objectName\": \"\",\n \"displayName\": \"\",\n \"apiName\": \"\"\n }\n ]\n },\n {\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"fromEmail\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"fromName\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"operational\": \"\",\n \"publishToMSI\": \"\",\n \"replyEmail\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"status\": \"\",\n \"subject\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"template\": \"\",\n \"textOnly\": \"\",\n \"webView\": \"\",\n \"autoCopyToText\": \"\",\n \"preHeader\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"version\": 2,\n \"workspace\": \"\",\n \"ccFields\": [\n {\n \"attributeId\": \"\",\n \"objectName\": \"\",\n \"displayName\": \"\",\n \"apiName\": \"\"\n },\n {\n \"attributeId\": \"\",\n \"objectName\": \"\",\n \"displayName\": \"\",\n \"apiName\": \"\"\n }\n ]\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "35549a7b-5ecd-4bb4-9ca0-6011d4cb934c", "name": "Create Email", "request": { "name": "Create Email", "description": { "content": "Creates a new email asset. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "emails.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "type", "value": "Folder" }, { "disabled": false, "description": { "content": "(Required) From-address of the Email", "type": "text/plain" }, "key": "fromEmail", "value": "" }, { "disabled": false, "description": { "content": "(Required) From-name of the Email", "type": "text/plain" }, "key": "fromName", "value": "" }, { "disabled": false, "description": { "content": "(Required) Name of the email", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": false, "description": { "content": "(Required) Reply-To address of the Email", "type": "text/plain" }, "key": "replyEmail", "value": "" }, { "disabled": false, "description": { "content": "(Required) Subject Line of the Email", "type": "text/plain" }, "key": "subject", "value": "" }, { "disabled": false, "description": { "content": "(Required) Id of the parent template", "type": "text/plain" }, "key": "template", "value": "" }, { "disabled": true, "description": { "content": "Description of the asset", "type": "text/plain" }, "key": "description", "value": "" }, { "disabled": true, "description": { "content": "Whether the email is operational. Operational emails bypass unsubscribe status. Defaults to false", "type": "text/plain" }, "key": "operational", "value": "" }, { "disabled": true, "description": { "content": "Setting to include text-only version of email when sent", "type": "text/plain" }, "key": "textOnly", "value": "" }, { "disabled": true, "description": { "content": "Setting to automatically copy HTML version to Text version", "type": "text/plain" }, "key": "autoCopyToText", "value": "" } ] }, "auth": null }, "response": [ { "id": "87eb386e-3c33-455c-9cdc-90b2fece656c", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "emails.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "type", "value": "Folder" }, { "disabled": false, "description": { "content": "(Required) From-address of the Email", "type": "text/plain" }, "key": "fromEmail", "value": "" }, { "disabled": false, "description": { "content": "(Required) From-name of the Email", "type": "text/plain" }, "key": "fromName", "value": "" }, { "disabled": false, "description": { "content": "(Required) Name of the email", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": false, "description": { "content": "(Required) Reply-To address of the Email", "type": "text/plain" }, "key": "replyEmail", "value": "" }, { "disabled": false, "description": { "content": "(Required) Subject Line of the Email", "type": "text/plain" }, "key": "subject", "value": "" }, { "disabled": false, "description": { "content": "(Required) Id of the parent template", "type": "text/plain" }, "key": "template", "value": "" }, { "disabled": true, "description": { "content": "Description of the asset", "type": "text/plain" }, "key": "description", "value": "" }, { "disabled": true, "description": { "content": "Whether the email is operational. Operational emails bypass unsubscribe status. Defaults to false", "type": "text/plain" }, "key": "operational", "value": "" }, { "disabled": true, "description": { "content": "Setting to include text-only version of email when sent", "type": "text/plain" }, "key": "textOnly", "value": "" }, { "disabled": true, "description": { "content": "Setting to automatically copy HTML version to Text version", "type": "text/plain" }, "key": "autoCopyToText", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"fromEmail\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"fromName\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"operational\": \"\",\n \"publishToMSI\": \"\",\n \"replyEmail\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"status\": \"\",\n \"subject\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"template\": \"\",\n \"textOnly\": \"\",\n \"webView\": \"\",\n \"autoCopyToText\": \"\",\n \"preHeader\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"version\": 2,\n \"workspace\": \"\",\n \"ccFields\": [\n {\n \"attributeId\": \"\",\n \"objectName\": \"\",\n \"displayName\": \"\",\n \"apiName\": \"\"\n },\n {\n \"attributeId\": \"\",\n \"objectName\": \"\",\n \"displayName\": \"\",\n \"apiName\": \"\"\n }\n ]\n },\n {\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"fromEmail\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"fromName\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"operational\": \"\",\n \"publishToMSI\": \"\",\n \"replyEmail\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"status\": \"\",\n \"subject\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"template\": \"\",\n \"textOnly\": \"\",\n \"webView\": \"\",\n \"autoCopyToText\": \"\",\n \"preHeader\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"version\": 2,\n \"workspace\": \"\",\n \"ccFields\": [\n {\n \"attributeId\": \"\",\n \"objectName\": \"\",\n \"displayName\": \"\",\n \"apiName\": \"\"\n },\n {\n \"attributeId\": \"\",\n \"objectName\": \"\",\n \"displayName\": \"\",\n \"apiName\": \"\"\n }\n ]\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Email Templates", "description": "CRUD operations on classic email templates, including HTML content and approval state.", "item": [ { "id": "6755234f-995c-4d7f-ac8d-3d334ab34910", "name": "Get Email Template by Name", "request": { "name": "Get Email Template by Name", "description": { "content": "Retrieves and email template record by the given name. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "emailTemplate", "byName.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) name", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "8c036d0f-060d-4516-99b4-a30a6d8a8e6c", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "emailTemplate", "byName.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) name", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"status\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"version\": 2,\n \"workspace\": \"\"\n },\n {\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"status\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"version\": 1,\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1743cd80-bd88-4928-bfa0-a76cd9f4efe5", "name": "Get Email Template by Id", "request": { "name": "Get Email Template by Id", "description": { "content": "Returns an email template record by its id. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "emailTemplate", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "256265fd-cad1-41df-ae65-828047fbb22e", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "emailTemplate", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"status\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"version\": 2,\n \"workspace\": \"\"\n },\n {\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"status\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"version\": 1,\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "52af95f2-b8c9-4018-99f3-b67ff9c1d72f", "name": "Update Email Template Metadata", "request": { "name": "Update Email Template Metadata", "description": { "content": "Updates the metadata for the designated email template. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "emailTemplate", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "Description of the asset", "type": "text/plain" }, "key": "description", "value": "" }, { "disabled": true, "description": { "content": "Name of the Email Template", "type": "text/plain" }, "key": "name", "value": "" } ] }, "auth": null }, "response": [ { "id": "827acb78-c7c5-43fc-bc7b-66acff3d3c7c", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "emailTemplate", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "Description of the asset", "type": "text/plain" }, "key": "description", "value": "" }, { "disabled": true, "description": { "content": "Name of the Email Template", "type": "text/plain" }, "key": "name", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"status\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"version\": 2,\n \"workspace\": \"\"\n },\n {\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"status\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"version\": 1,\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f0aff7f7-8d96-4617-a1be-d91c94eb66df", "name": "Approve Email Template Draft", "request": { "name": "Approve Email Template Draft", "description": { "content": "Approves the current draft of the email template. Required Permissions: Approve Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "emailTemplate", ":id", "approveDraft.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "bd8bedd6-9057-4682-b64a-010ef27118d3", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "emailTemplate", ":id", "approveDraft.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"status\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"version\": 2,\n \"workspace\": \"\"\n },\n {\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"status\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"version\": 1,\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b843c7ca-8843-4b2c-a777-aafa3b57596f", "name": "Clone Email Template", "request": { "name": "Clone Email Template", "description": { "content": "Clones the designated email template. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "emailTemplate", ":id", "clone.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "type", "value": "Program" }, { "disabled": false, "description": { "content": "(Required) Name of the Email Template", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Description of the asset", "type": "text/plain" }, "key": "description", "value": "" } ] }, "auth": null }, "response": [ { "id": "a49aa33a-a51b-4ef6-b0a0-74b420a69c38", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "emailTemplate", ":id", "clone.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "type", "value": "Program" }, { "disabled": false, "description": { "content": "(Required) Name of the Email Template", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Description of the asset", "type": "text/plain" }, "key": "description", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"status\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"version\": 2,\n \"workspace\": \"\"\n },\n {\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"status\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"version\": 1,\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0bfd00ff-f2e9-44c3-b05e-5f98b3dde91f", "name": "Get Email Template Content by Id", "request": { "name": "Get Email Template Content by Id", "description": { "content": "Returns the content for a given email template. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "emailTemplate", ":id", "content" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4c6b66bb-13fb-4c7c-88e6-6c99f475fe28", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "emailTemplate", ":id", "content" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"content\": \"\",\n \"id\": \"\",\n \"status\": \"approved\"\n },\n {\n \"content\": \"\",\n \"id\": \"\",\n \"status\": \"approved\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b0f997ff-d42e-4487-9285-e590194e8d77", "name": "Update Email Template Content", "request": { "name": "Update Email Template Content", "description": { "content": "Updates the content of the given email template. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "emailTemplate", ":id", "content.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Content for the email template. Multipart file.", "type": "text/plain" }, "key": "content", "value": "", "type": "text" } ] }, "auth": null }, "response": [ { "id": "d9723cfb-5771-445d-9af2-da78ce91a31f", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "emailTemplate", ":id", "content.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Content for the email template. Multipart file.", "type": "text/plain" }, "key": "content", "value": "", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "51f1ddf4-edc2-4a9e-bef4-4c60c4ff2dca", "name": "Delete Email Template", "request": { "name": "Delete Email Template", "description": { "content": "Deletes the designated email template. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "emailTemplate", ":id", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "946c7034-4e53-4c52-922f-06beb86bcb31", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "emailTemplate", ":id", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "006c88cb-d835-4d47-8166-26334b04353c", "name": "Discard Email Template Draft", "request": { "name": "Discard Email Template Draft", "description": { "content": "Discards the current draft of the email template. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "emailTemplate", ":id", "discardDraft.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "5cc23672-fd65-44dc-a3ef-cc61371a8756", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "emailTemplate", ":id", "discardDraft.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8e6b4a00-fe23-413f-9668-477f7f44fbed", "name": "Unapprove Email Template Draft", "request": { "name": "Unapprove Email Template Draft", "description": { "content": "Unapproves the current approved version of the Email Template. Required Permissions: Approve Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "emailTemplate", ":id", "unapprove.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "e157dd85-d923-4bdd-81ab-8742d2227bed", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "emailTemplate", ":id", "unapprove.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"status\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"version\": 2,\n \"workspace\": \"\"\n },\n {\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"status\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"version\": 1,\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "790bf488-40d1-4463-9885-a1630afaca8e", "name": "Get Email Templates", "request": { "name": "Get Email Templates", "description": { "content": "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 endpoint.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "emailTemplates.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of records to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3e16a386-c7f0-4723-ba4f-ae9759a74465", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "emailTemplates.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of records to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"status\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"version\": 2,\n \"workspace\": \"\"\n },\n {\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"status\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"version\": 1,\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d4681adc-1db0-4081-a9fb-b791d1deb555", "name": "Create Email Template", "request": { "name": "Create Email Template", "description": { "content": "Creates a new email template. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "emailTemplates.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Name of the Email Template. Must be unique under the parent folder.", "type": "text/plain" }, "key": "name", "value": "", "type": "text" }, { "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "folder", "value": "[object Object]", "type": "text" }, { "description": { "content": "(Required) HTML content for template. Multipart file.", "type": "text/plain" }, "key": "content", "value": "", "type": "text" }, { "description": { "content": "Description of the email template", "type": "text/plain" }, "key": "description", "value": "", "type": "text" } ] }, "auth": null }, "response": [ { "id": "5926f6e5-a109-4629-8d41-9293d00bb8f4", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "emailTemplates.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Name of the Email Template. Must be unique under the parent folder.", "type": "text/plain" }, "key": "name", "value": "", "type": "text" }, { "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "folder", "value": "[object Object]", "type": "text" }, { "description": { "content": "(Required) HTML content for template. Multipart file.", "type": "text/plain" }, "key": "content", "value": "", "type": "text" }, { "description": { "content": "Description of the email template", "type": "text/plain" }, "key": "description", "value": "", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"status\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"version\": 2,\n \"workspace\": \"\"\n },\n {\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"status\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"version\": 1,\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fc5eea07-2cd2-483e-9cf3-b47a5e68f6ed", "name": "Get Email Template Used By", "request": { "name": "Get Email Template Used By", "description": { "content": "Returns a list of email records which depend on a given email template. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "emailTemplates", ":id", "usedBy.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of records to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Id of the email template", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6c642128-5466-4e1f-93a0-b92e1c6e5070", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "emailTemplates", ":id", "usedBy.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of records to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the email template", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"status\": \"draft\",\n \"updatedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"status\": \"approved\",\n \"updatedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Emails (New)", "description": "Emails authored in the new Email Designer. These endpoints use a distinct payload shape from the classic Emails endpoints.", "item": [ { "id": "05128548-600a-4141-be9f-f90907f81e47", "name": "Create Email", "request": { "name": "Create Email", "description": { "content": "Creates a new email asset. Required Permissions: Read-Write Assets, Access Design Studio, Edit Email.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v2", "email" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "{{access_token}}" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"programId\": \"\",\n \"workspaceId\": \"\"\n },\n \"headers\": {\n \"subject\": \"\",\n \"ccEmails\": [\n \"\",\n \"\"\n ],\n \"fromEmail\": \"\",\n \"fromName\": \"\",\n \"preheader\": \"\",\n \"replyEmail\": \"\"\n },\n \"description\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n },\n \"editorContext\": {\n \"dynamicContent\": {}\n },\n \"settings\": {\n \"brandedDomain\": \"\",\n \"dedicatedIp\": \"\",\n \"enableUrlTracking\": \"\",\n \"isOperational\": \"\",\n \"isTextOnly\": \"\",\n \"isWebPageView\": \"\"\n },\n \"templateId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "5e63bb6e-f57a-48d4-a192-74e4106170b6", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "email" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"programId\": \"\",\n \"workspaceId\": \"\"\n },\n \"headers\": {\n \"subject\": \"\",\n \"ccEmails\": [\n \"\",\n \"\"\n ],\n \"fromEmail\": \"\",\n \"fromName\": \"\",\n \"preheader\": \"\",\n \"replyEmail\": \"\"\n },\n \"description\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n },\n \"editorContext\": {\n \"dynamicContent\": {}\n },\n \"settings\": {\n \"brandedDomain\": \"\",\n \"dedicatedIp\": \"\",\n \"enableUrlTracking\": \"\",\n \"isOperational\": \"\",\n \"isTextOnly\": \"\",\n \"isWebPageView\": \"\"\n },\n \"templateId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"headers\": {\n \"subject\": \"\",\n \"ccEmails\": [\n \"\",\n \"\"\n ],\n \"fromEmail\": \"\",\n \"fromName\": \"\",\n \"preheader\": \"\",\n \"replyEmail\": \"\"\n },\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"settings\": {\n \"isOperational\": \"\",\n \"isWebPageView\": \"\",\n \"isTextOnly\": \"\",\n \"disableOpenTracking\": \"\",\n \"enableUrlTracking\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"appData\": {\n \"editorType\": \"\",\n \"workspaceId\": \"\",\n \"folderId\": \"\",\n \"programId\": \"\",\n \"programName\": \"\",\n \"programType\": \"\"\n },\n \"templateId\": \"\",\n \"externalId\": \"\",\n \"editorContext\": {\n \"dynamicContent\": {}\n },\n \"scriptEngine\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"headers\": {\n \"subject\": \"\",\n \"ccEmails\": [\n \"\",\n \"\"\n ],\n \"fromEmail\": \"\",\n \"fromName\": \"\",\n \"preheader\": \"\",\n \"replyEmail\": \"\"\n },\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"settings\": {\n \"isOperational\": \"\",\n \"isWebPageView\": \"\",\n \"isTextOnly\": \"\",\n \"disableOpenTracking\": \"\",\n \"enableUrlTracking\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"appData\": {\n \"editorType\": \"\",\n \"workspaceId\": \"\",\n \"folderId\": \"\",\n \"programId\": \"\",\n \"programName\": \"\",\n \"programType\": \"\"\n },\n \"templateId\": \"\",\n \"externalId\": \"\",\n \"editorContext\": {\n \"dynamicContent\": {}\n },\n \"scriptEngine\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f93c4e0b-1620-4711-9662-df8eab7cc52c", "name": "Error", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "email" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"programId\": \"\",\n \"workspaceId\": \"\"\n },\n \"headers\": {\n \"subject\": \"\",\n \"ccEmails\": [\n \"\",\n \"\"\n ],\n \"fromEmail\": \"\",\n \"fromName\": \"\",\n \"preheader\": \"\",\n \"replyEmail\": \"\"\n },\n \"description\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n },\n \"editorContext\": {\n \"dynamicContent\": {}\n },\n \"settings\": {\n \"brandedDomain\": \"\",\n \"dedicatedIp\": \"\",\n \"enableUrlTracking\": \"\",\n \"isOperational\": \"\",\n \"isTextOnly\": \"\",\n \"isWebPageView\": \"\"\n },\n \"templateId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a7339fc8-9706-4ee5-bd27-b32732e9ca55", "name": "Bulk Delete Emails", "request": { "name": "Bulk Delete Emails", "description": { "content": "Deletes 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.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v2", "email", "bulk", "delete" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "{{access_token}}" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header", "type": "text/plain" }, "key": "x-app-type", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetIds\": [\n \"\",\n \"\"\n ],\n \"ignoreUsedBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "3c752cc2-f9a4-4f68-a825-5a0369a3c09e", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "email", "bulk", "delete" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header", "type": "text/plain" }, "key": "x-app-type", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetIds\": [\n \"\",\n \"\"\n ],\n \"ignoreUsedBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d68cb1e-2d61-40dc-b87a-073f12dcfbe5", "name": "Error", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "email", "bulk", "delete" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header", "type": "text/plain" }, "key": "x-app-type", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetIds\": [\n \"\",\n \"\"\n ],\n \"ignoreUsedBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f713b010-f3a5-4edc-832f-ee176a155460", "name": "Bulk Get Emails", "request": { "name": "Bulk Get Emails", "description": { "content": "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.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v2", "email", "bulk", "get" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "{{access_token}}" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header", "type": "text/plain" }, "key": "x-app-type", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "2867496b-092e-4cd0-8bd0-7078406cff8c", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "email", "bulk", "get" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header", "type": "text/plain" }, "key": "x-app-type", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"headers\": {\n \"subject\": \"\",\n \"ccEmails\": [\n \"\",\n \"\"\n ],\n \"fromEmail\": \"\",\n \"fromName\": \"\",\n \"preheader\": \"\",\n \"replyEmail\": \"\"\n },\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"settings\": {\n \"isOperational\": \"\",\n \"isWebPageView\": \"\",\n \"isTextOnly\": \"\",\n \"disableOpenTracking\": \"\",\n \"enableUrlTracking\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"appData\": {\n \"editorType\": \"\",\n \"workspaceId\": \"\",\n \"folderId\": \"\",\n \"programId\": \"\",\n \"programName\": \"\",\n \"programType\": \"\"\n },\n \"templateId\": \"\",\n \"externalId\": \"\",\n \"editorContext\": {\n \"dynamicContent\": {}\n },\n \"scriptEngine\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"headers\": {\n \"subject\": \"\",\n \"ccEmails\": [\n \"\",\n \"\"\n ],\n \"fromEmail\": \"\",\n \"fromName\": \"\",\n \"preheader\": \"\",\n \"replyEmail\": \"\"\n },\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"settings\": {\n \"isOperational\": \"\",\n \"isWebPageView\": \"\",\n \"isTextOnly\": \"\",\n \"disableOpenTracking\": \"\",\n \"enableUrlTracking\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"appData\": {\n \"editorType\": \"\",\n \"workspaceId\": \"\",\n \"folderId\": \"\",\n \"programId\": \"\",\n \"programName\": \"\",\n \"programType\": \"\"\n },\n \"templateId\": \"\",\n \"externalId\": \"\",\n \"editorContext\": {\n \"dynamicContent\": {}\n },\n \"scriptEngine\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c8d73b8-3688-48e2-bbd6-789c4b32a641", "name": "Error", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "email", "bulk", "get" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header", "type": "text/plain" }, "key": "x-app-type", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c24c1e7d-82b5-463a-aab3-46adb6efcc01", "name": "Bulk Get Emails Used By", "request": { "name": "Bulk Get Emails Used By", "description": { "content": "Returns, for each of the specified emails, whether it is used and the number of places it is used (count) \u2014 not the referencing assets themselves. Maximum 50 assets per request. Required Permissions: Read-Only Assets, Access Design Studio.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v2", "email", "bulk", "usedby" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "{{access_token}}" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header", "type": "text/plain" }, "key": "x-app-type", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9f91fb7c-f1e7-4ad3-8f82-44eb0f915c70", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "email", "bulk", "usedby" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header", "type": "text/plain" }, "key": "x-app-type", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"count\": \"\",\n \"used\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"count\": \"\",\n \"used\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4db50499-bb6e-4d8e-8693-ce08b6250dd7", "name": "Error", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "email", "bulk", "usedby" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header", "type": "text/plain" }, "key": "x-app-type", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4aa87d9e-b976-42e5-be09-2942815162ec", "name": "Clone Email", "request": { "name": "Clone Email", "description": { "content": "Clones an existing email asset. Required Permissions: Read-Write Assets, Access Design Studio, Edit Email.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v2", "email", "clone" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "{{access_token}}" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetId\": \"\",\n \"newAsset\": {\n \"name\": \"\",\n \"description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ddbf7be8-9df4-4efe-b66c-55fa115943d9", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "email", "clone" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetId\": \"\",\n \"newAsset\": {\n \"name\": \"\",\n \"description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"headers\": {\n \"subject\": \"\",\n \"ccEmails\": [\n \"\",\n \"\"\n ],\n \"fromEmail\": \"\",\n \"fromName\": \"\",\n \"preheader\": \"\",\n \"replyEmail\": \"\"\n },\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"settings\": {\n \"isOperational\": \"\",\n \"isWebPageView\": \"\",\n \"isTextOnly\": \"\",\n \"disableOpenTracking\": \"\",\n \"enableUrlTracking\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"appData\": {\n \"editorType\": \"\",\n \"workspaceId\": \"\",\n \"folderId\": \"\",\n \"programId\": \"\",\n \"programName\": \"\",\n \"programType\": \"\"\n },\n \"templateId\": \"\",\n \"externalId\": \"\",\n \"editorContext\": {\n \"dynamicContent\": {}\n },\n \"scriptEngine\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"headers\": {\n \"subject\": \"\",\n \"ccEmails\": [\n \"\",\n \"\"\n ],\n \"fromEmail\": \"\",\n \"fromName\": \"\",\n \"preheader\": \"\",\n \"replyEmail\": \"\"\n },\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"settings\": {\n \"isOperational\": \"\",\n \"isWebPageView\": \"\",\n \"isTextOnly\": \"\",\n \"disableOpenTracking\": \"\",\n \"enableUrlTracking\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"appData\": {\n \"editorType\": \"\",\n \"workspaceId\": \"\",\n \"folderId\": \"\",\n \"programId\": \"\",\n \"programName\": \"\",\n \"programType\": \"\"\n },\n \"templateId\": \"\",\n \"externalId\": \"\",\n \"editorContext\": {\n \"dynamicContent\": {}\n },\n \"scriptEngine\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b989e68b-63c6-4a32-afd4-b3e022d9b233", "name": "Error", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "email", "clone" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetId\": \"\",\n \"newAsset\": {\n \"name\": \"\",\n \"description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b3af5ea3-bb8e-4509-b805-d41fac641285", "name": "List Emails", "request": { "name": "List Emails", "description": { "content": "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.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v2", "email", "filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "{{access_token}}" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "workspaceId", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "folderId", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of Folder,Program)", "type": "text/plain" }, "key": "folderType", "value": "Program" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "pageIndex", "value": "" }, { "disabled": true, "description": { "content": "Maximum value is 50.", "type": "text/plain" }, "key": "pageSize", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "createdAtEnd", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "createdAtStart", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "modifiedAtStart", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "modifiedAtEnd", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "sortKey", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of ASC,DESC)", "type": "text/plain" }, "key": "sortOrder", "value": "DESC" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "isCreatedByMe", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "isModifiedByMe", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "templateId", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "scriptEngine", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "isValueNonNullable", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "includeArchived", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "934ea316-3b83-442d-b8e1-fb883ea13f7a", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "email", "filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "workspaceId", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "folderId", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of Folder,Program)", "type": "text/plain" }, "key": "folderType", "value": "Program" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "pageIndex", "value": "" }, { "disabled": true, "description": { "content": "Maximum value is 50.", "type": "text/plain" }, "key": "pageSize", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "createdAtEnd", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "createdAtStart", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "modifiedAtStart", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "modifiedAtEnd", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "sortKey", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of ASC,DESC)", "type": "text/plain" }, "key": "sortOrder", "value": "DESC" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "isCreatedByMe", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "isModifiedByMe", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "templateId", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "scriptEngine", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "isValueNonNullable", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "includeArchived", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"result\": {\n \"totalItems\": \"\",\n \"pageSize\": \"\",\n \"currentPage\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"headers\": {\n \"subject\": \"\",\n \"ccEmails\": [\n \"\",\n \"\"\n ],\n \"fromEmail\": \"\",\n \"fromName\": \"\",\n \"preheader\": \"\",\n \"replyEmail\": \"\"\n },\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"settings\": {\n \"isOperational\": \"\",\n \"isWebPageView\": \"\",\n \"isTextOnly\": \"\",\n \"disableOpenTracking\": \"\",\n \"enableUrlTracking\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"appData\": {\n \"editorType\": \"\",\n \"workspaceId\": \"\",\n \"folderId\": \"\",\n \"programId\": \"\",\n \"programName\": \"\",\n \"programType\": \"\"\n },\n \"templateId\": \"\",\n \"externalId\": \"\",\n \"editorContext\": {\n \"dynamicContent\": {}\n },\n \"scriptEngine\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"headers\": {\n \"subject\": \"\",\n \"ccEmails\": [\n \"\",\n \"\"\n ],\n \"fromEmail\": \"\",\n \"fromName\": \"\",\n \"preheader\": \"\",\n \"replyEmail\": \"\"\n },\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"settings\": {\n \"isOperational\": \"\",\n \"isWebPageView\": \"\",\n \"isTextOnly\": \"\",\n \"disableOpenTracking\": \"\",\n \"enableUrlTracking\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"appData\": {\n \"editorType\": \"\",\n \"workspaceId\": \"\",\n \"folderId\": \"\",\n \"programId\": \"\",\n \"programName\": \"\",\n \"programType\": \"\"\n },\n \"templateId\": \"\",\n \"externalId\": \"\",\n \"editorContext\": {\n \"dynamicContent\": {}\n },\n \"scriptEngine\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2e86aee-a346-43c9-bb85-10a30c8cd2b8", "name": "Error", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "email", "filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "workspaceId", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "folderId", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of Folder,Program)", "type": "text/plain" }, "key": "folderType", "value": "Program" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "pageIndex", "value": "" }, { "disabled": true, "description": { "content": "Maximum value is 50.", "type": "text/plain" }, "key": "pageSize", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "createdAtEnd", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "createdAtStart", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "modifiedAtStart", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "modifiedAtEnd", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "sortKey", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of ASC,DESC)", "type": "text/plain" }, "key": "sortOrder", "value": "DESC" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "isCreatedByMe", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "isModifiedByMe", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "templateId", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "scriptEngine", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "isValueNonNullable", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "includeArchived", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3492e875-bf29-429a-a07e-52d6fc0eea7a", "name": "Update Email Status", "request": { "name": "Update Email Status", "description": { "content": "Performs a state transition on an email. Required Permissions: Read-Write Assets, Access Design Studio, Approve Email.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v2", "email", "state", "transition" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "{{access_token}}" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contentId\": \"\",\n \"action\": \"discard\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "673d0b08-1e01-496a-aafc-2fa3abdbea15", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "email", "state", "transition" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contentId\": \"\",\n \"action\": \"discard\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"headers\": {\n \"subject\": \"\",\n \"ccEmails\": [\n \"\",\n \"\"\n ],\n \"fromEmail\": \"\",\n \"fromName\": \"\",\n \"preheader\": \"\",\n \"replyEmail\": \"\"\n },\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"settings\": {\n \"isOperational\": \"\",\n \"isWebPageView\": \"\",\n \"isTextOnly\": \"\",\n \"disableOpenTracking\": \"\",\n \"enableUrlTracking\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"appData\": {\n \"editorType\": \"\",\n \"workspaceId\": \"\",\n \"folderId\": \"\",\n \"programId\": \"\",\n \"programName\": \"\",\n \"programType\": \"\"\n },\n \"templateId\": \"\",\n \"externalId\": \"\",\n \"editorContext\": {\n \"dynamicContent\": {}\n },\n \"scriptEngine\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"headers\": {\n \"subject\": \"\",\n \"ccEmails\": [\n \"\",\n \"\"\n ],\n \"fromEmail\": \"\",\n \"fromName\": \"\",\n \"preheader\": \"\",\n \"replyEmail\": \"\"\n },\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"settings\": {\n \"isOperational\": \"\",\n \"isWebPageView\": \"\",\n \"isTextOnly\": \"\",\n \"disableOpenTracking\": \"\",\n \"enableUrlTracking\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"appData\": {\n \"editorType\": \"\",\n \"workspaceId\": \"\",\n \"folderId\": \"\",\n \"programId\": \"\",\n \"programName\": \"\",\n \"programType\": \"\"\n },\n \"templateId\": \"\",\n \"externalId\": \"\",\n \"editorContext\": {\n \"dynamicContent\": {}\n },\n \"scriptEngine\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9af8c08c-3ea0-4c18-ad41-b519bf76c509", "name": "Error", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "email", "state", "transition" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contentId\": \"\",\n \"action\": \"discard\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "87075ed1-c17d-4ad8-96b5-6ccc00bee614", "name": "Get Email Used By", "request": { "name": "Get Email Used By", "description": { "content": "Returns a list of assets that reference the specified email. Required Permissions: Read-Only Assets, Access Design Studio.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v2", "email", "usedby" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "{{access_token}}" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetId\": \"\",\n \"pageIndex\": \"\",\n \"pageSize\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "8b2179df-d98d-48f9-8451-11e925c13d00", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "email", "usedby" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetId\": \"\",\n \"pageIndex\": \"\",\n \"pageSize\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"channel\": \"\",\n \"contentType\": \"\",\n \"externalId\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"channel\": \"\",\n \"contentType\": \"\",\n \"externalId\": \"\"\n }\n ],\n \"pageDetails\": {\n \"totalItems\": \"\",\n \"pageSize\": \"\",\n \"currentPage\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b60b274e-2c2f-47cf-97f2-c0ebc4bc8ca1", "name": "Error", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "email", "usedby" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetId\": \"\",\n \"pageIndex\": \"\",\n \"pageSize\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "85cd91f6-ef07-4667-bdba-c2ea4ab4c1e8", "name": "Get Email by Id", "request": { "name": "Get Email by Id", "description": { "content": "Retrieves an email asset by its ID. Required Permissions: Read-Only Assets, Access Design Studio, Access Email.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v2", "email", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "{{access_token}}" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0f90a22f-2fea-4c7a-ba9e-0e8f84526ebe", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "email", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"headers\": {\n \"subject\": \"\",\n \"ccEmails\": [\n \"\",\n \"\"\n ],\n \"fromEmail\": \"\",\n \"fromName\": \"\",\n \"preheader\": \"\",\n \"replyEmail\": \"\"\n },\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"settings\": {\n \"isOperational\": \"\",\n \"isWebPageView\": \"\",\n \"isTextOnly\": \"\",\n \"disableOpenTracking\": \"\",\n \"enableUrlTracking\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"appData\": {\n \"editorType\": \"\",\n \"workspaceId\": \"\",\n \"folderId\": \"\",\n \"programId\": \"\",\n \"programName\": \"\",\n \"programType\": \"\"\n },\n \"templateId\": \"\",\n \"externalId\": \"\",\n \"editorContext\": {\n \"dynamicContent\": {}\n },\n \"scriptEngine\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"headers\": {\n \"subject\": \"\",\n \"ccEmails\": [\n \"\",\n \"\"\n ],\n \"fromEmail\": \"\",\n \"fromName\": \"\",\n \"preheader\": \"\",\n \"replyEmail\": \"\"\n },\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"settings\": {\n \"isOperational\": \"\",\n \"isWebPageView\": \"\",\n \"isTextOnly\": \"\",\n \"disableOpenTracking\": \"\",\n \"enableUrlTracking\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"appData\": {\n \"editorType\": \"\",\n \"workspaceId\": \"\",\n \"folderId\": \"\",\n \"programId\": \"\",\n \"programName\": \"\",\n \"programType\": \"\"\n },\n \"templateId\": \"\",\n \"externalId\": \"\",\n \"editorContext\": {\n \"dynamicContent\": {}\n },\n \"scriptEngine\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ecadfd6-643a-424f-8ede-9552b6c0dfa2", "name": "Error", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "email", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3cfbd298-9804-4a42-9757-3619c237d275", "name": "Delete Email", "request": { "name": "Delete Email", "description": { "content": "Deletes an email asset by its ID. Required Permissions: Read-Write Assets, Access Design Studio, Delete Email.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v2", "email", ":id", "delete" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "{{access_token}}" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "d0b1b96a-b24e-4a87-b281-e0a5efc139b6", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "email", ":id", "delete" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6698dc63-532d-46e1-a864-3aa3c768ec3f", "name": "Error", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "email", ":id", "delete" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "edde3b72-3ce0-4357-a0a7-dcbd8e9a194e", "name": "Update Email", "request": { "name": "Update Email", "description": { "content": "Updates an existing email asset. Required Permissions: Read-Write Assets, Access Design Studio, Edit Email.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v2", "email", ":id", "update" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "{{access_token}}" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n },\n \"headers\": {\n \"ccEmails\": [\n \"\",\n \"\"\n ],\n \"fromEmail\": \"\",\n \"fromName\": \"\",\n \"preheader\": \"\",\n \"replyEmail\": \"\",\n \"subject\": \"\"\n },\n \"editorContext\": {\n \"dynamicContent\": {}\n },\n \"settings\": {\n \"brandedDomain\": \"\",\n \"dedicatedIp\": \"\",\n \"enableUrlTracking\": \"\",\n \"isOperational\": \"\",\n \"isTextOnly\": \"\",\n \"isWebPageView\": \"\"\n },\n \"templateId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "41e7eba3-3fa4-4c23-8fe1-0bc3f02d88d7", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "email", ":id", "update" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n },\n \"headers\": {\n \"ccEmails\": [\n \"\",\n \"\"\n ],\n \"fromEmail\": \"\",\n \"fromName\": \"\",\n \"preheader\": \"\",\n \"replyEmail\": \"\",\n \"subject\": \"\"\n },\n \"editorContext\": {\n \"dynamicContent\": {}\n },\n \"settings\": {\n \"brandedDomain\": \"\",\n \"dedicatedIp\": \"\",\n \"enableUrlTracking\": \"\",\n \"isOperational\": \"\",\n \"isTextOnly\": \"\",\n \"isWebPageView\": \"\"\n },\n \"templateId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"headers\": {\n \"subject\": \"\",\n \"ccEmails\": [\n \"\",\n \"\"\n ],\n \"fromEmail\": \"\",\n \"fromName\": \"\",\n \"preheader\": \"\",\n \"replyEmail\": \"\"\n },\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"settings\": {\n \"isOperational\": \"\",\n \"isWebPageView\": \"\",\n \"isTextOnly\": \"\",\n \"disableOpenTracking\": \"\",\n \"enableUrlTracking\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"appData\": {\n \"editorType\": \"\",\n \"workspaceId\": \"\",\n \"folderId\": \"\",\n \"programId\": \"\",\n \"programName\": \"\",\n \"programType\": \"\"\n },\n \"templateId\": \"\",\n \"externalId\": \"\",\n \"editorContext\": {\n \"dynamicContent\": {}\n },\n \"scriptEngine\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"headers\": {\n \"subject\": \"\",\n \"ccEmails\": [\n \"\",\n \"\"\n ],\n \"fromEmail\": \"\",\n \"fromName\": \"\",\n \"preheader\": \"\",\n \"replyEmail\": \"\"\n },\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"settings\": {\n \"isOperational\": \"\",\n \"isWebPageView\": \"\",\n \"isTextOnly\": \"\",\n \"disableOpenTracking\": \"\",\n \"enableUrlTracking\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"appData\": {\n \"editorType\": \"\",\n \"workspaceId\": \"\",\n \"folderId\": \"\",\n \"programId\": \"\",\n \"programName\": \"\",\n \"programType\": \"\"\n },\n \"templateId\": \"\",\n \"externalId\": \"\",\n \"editorContext\": {\n \"dynamicContent\": {}\n },\n \"scriptEngine\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4eaf685d-28d1-4332-9e28-b7ebebf831ad", "name": "Error", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "email", ":id", "update" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n },\n \"headers\": {\n \"ccEmails\": [\n \"\",\n \"\"\n ],\n \"fromEmail\": \"\",\n \"fromName\": \"\",\n \"preheader\": \"\",\n \"replyEmail\": \"\",\n \"subject\": \"\"\n },\n \"editorContext\": {\n \"dynamicContent\": {}\n },\n \"settings\": {\n \"brandedDomain\": \"\",\n \"dedicatedIp\": \"\",\n \"enableUrlTracking\": \"\",\n \"isOperational\": \"\",\n \"isTextOnly\": \"\",\n \"isWebPageView\": \"\"\n },\n \"templateId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Email Templates (New)", "description": "Email templates authored in the new Email Designer.", "item": [ { "id": "5b1a820a-702e-44e5-a00a-69c42270f930", "name": "Create Email Template", "request": { "name": "Create Email Template", "description": { "content": "Creates a new email template. Required Permissions: Read-Write Assets, Access Design Studio, Edit Email Template.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v2", "emailtemplate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "{{access_token}}" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"description\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n },\n \"editorContext\": {\n \"dynamicContent\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a5f83901-d26f-4a49-aa1e-4fe20169d171", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "emailtemplate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"description\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n },\n \"editorContext\": {\n \"dynamicContent\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"version\": \"\",\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"externalId\": \"\",\n \"scriptEngine\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"version\": \"\",\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"externalId\": \"\",\n \"scriptEngine\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82abb5fe-889b-4536-a95b-a02c0c29dbb8", "name": "Error", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "emailtemplate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"description\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n },\n \"editorContext\": {\n \"dynamicContent\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "86827206-c4ce-4917-9190-7bc1bee9bb4e", "name": "Bulk Delete Email Templates", "request": { "name": "Bulk Delete Email Templates", "description": { "content": "Deletes 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.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v2", "emailtemplate", "bulk", "delete" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "{{access_token}}" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header", "type": "text/plain" }, "key": "x-app-type", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetIds\": [\n \"\",\n \"\"\n ],\n \"ignoreUsedBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "19668263-06ea-4fde-8de4-0a65e558256a", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "emailtemplate", "bulk", "delete" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header", "type": "text/plain" }, "key": "x-app-type", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetIds\": [\n \"\",\n \"\"\n ],\n \"ignoreUsedBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fdbbaf09-241e-483d-9a10-ceea663aea24", "name": "Error", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "emailtemplate", "bulk", "delete" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header", "type": "text/plain" }, "key": "x-app-type", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetIds\": [\n \"\",\n \"\"\n ],\n \"ignoreUsedBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b78a1505-3123-4f49-a1aa-cd29d55a1957", "name": "Bulk Get Email Templates", "request": { "name": "Bulk Get Email Templates", "description": { "content": "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.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v2", "emailtemplate", "bulk", "get" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "{{access_token}}" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header", "type": "text/plain" }, "key": "x-app-type", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a81ed69f-d71f-464f-91ef-59eb7fc22c18", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "emailtemplate", "bulk", "get" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header", "type": "text/plain" }, "key": "x-app-type", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"version\": \"\",\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"externalId\": \"\",\n \"scriptEngine\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"version\": \"\",\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"externalId\": \"\",\n \"scriptEngine\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8708b8f6-0911-48e7-a45f-5610bc8e622c", "name": "Error", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "emailtemplate", "bulk", "get" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header", "type": "text/plain" }, "key": "x-app-type", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1b524b1a-77cf-4479-88ba-8e45c5f3a9a4", "name": "Bulk Get Email Templates Used By", "request": { "name": "Bulk Get Email Templates Used By", "description": { "content": "Returns, for each of the specified email templates, whether it is used and the number of places it is used (count) \u2014 not the referencing assets themselves. Maximum 50 assets per request. Required Permissions: Read-Only Assets, Access Design Studio.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v2", "emailtemplate", "bulk", "usedby" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "{{access_token}}" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header", "type": "text/plain" }, "key": "x-app-type", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "0255043e-474a-40be-935f-7afb5218ed49", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "emailtemplate", "bulk", "usedby" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header", "type": "text/plain" }, "key": "x-app-type", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"count\": \"\",\n \"used\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"count\": \"\",\n \"used\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6ab15cd-0b71-4d0b-9b70-da66a8328f4d", "name": "Error", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "emailtemplate", "bulk", "usedby" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header", "type": "text/plain" }, "key": "x-app-type", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "94ce9f91-0002-4418-90d0-4e8cc7bfa489", "name": "Clone Email Template", "request": { "name": "Clone Email Template", "description": { "content": "Clones an existing email template. Required Permissions: Read-Write Assets, Access Design Studio, Edit Email Template.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v2", "emailtemplate", "clone" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "{{access_token}}" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetId\": \"\",\n \"newAsset\": {\n \"name\": \"\",\n \"description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "05d2cd9e-64e2-44a0-9b79-d3e23edbef5c", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "emailtemplate", "clone" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetId\": \"\",\n \"newAsset\": {\n \"name\": \"\",\n \"description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"version\": \"\",\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"externalId\": \"\",\n \"scriptEngine\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"version\": \"\",\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"externalId\": \"\",\n \"scriptEngine\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a1f0734-e817-4cea-b4bf-2ca8fa1cde28", "name": "Error", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "emailtemplate", "clone" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetId\": \"\",\n \"newAsset\": {\n \"name\": \"\",\n \"description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1ee90d66-a082-4765-ba56-7f2664bc56a7", "name": "List Email Templates", "request": { "name": "List Email Templates", "description": { "content": "Filters and lists email templates by the given criteria. Required Permissions: Read-Only Assets, Access Design Studio, Access Email Template.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v2", "emailtemplate", "filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "{{access_token}}" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "workspaceId", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "folderId", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of Folder,Program)", "type": "text/plain" }, "key": "folderType", "value": "Program" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "pageIndex", "value": "" }, { "disabled": true, "description": { "content": "Maximum value is 50.", "type": "text/plain" }, "key": "pageSize", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "createdAtEnd", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "createdAtStart", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "modifiedAtStart", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "modifiedAtEnd", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "sortKey", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of ASC,DESC)", "type": "text/plain" }, "key": "sortOrder", "value": "DESC" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "isCreatedByMe", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "isModifiedByMe", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "scriptEngine", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "isValueNonNullable", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "includeArchived", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "dfb48a83-1700-4f52-a30a-0be48f4b3e37", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "emailtemplate", "filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "workspaceId", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "folderId", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of Folder,Program)", "type": "text/plain" }, "key": "folderType", "value": "Program" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "pageIndex", "value": "" }, { "disabled": true, "description": { "content": "Maximum value is 50.", "type": "text/plain" }, "key": "pageSize", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "createdAtEnd", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "createdAtStart", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "modifiedAtStart", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "modifiedAtEnd", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "sortKey", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of ASC,DESC)", "type": "text/plain" }, "key": "sortOrder", "value": "DESC" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "isCreatedByMe", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "isModifiedByMe", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "scriptEngine", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "isValueNonNullable", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "includeArchived", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"result\": {\n \"totalItems\": \"\",\n \"pageSize\": \"\",\n \"currentPage\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"version\": \"\",\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"externalId\": \"\",\n \"scriptEngine\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"version\": \"\",\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"externalId\": \"\",\n \"scriptEngine\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da9b407a-b560-4dfb-a679-9b030e0e1e63", "name": "Error", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "emailtemplate", "filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "workspaceId", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "folderId", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of Folder,Program)", "type": "text/plain" }, "key": "folderType", "value": "Program" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "pageIndex", "value": "" }, { "disabled": true, "description": { "content": "Maximum value is 50.", "type": "text/plain" }, "key": "pageSize", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "createdAtEnd", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "createdAtStart", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "modifiedAtStart", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "modifiedAtEnd", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "sortKey", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of ASC,DESC)", "type": "text/plain" }, "key": "sortOrder", "value": "DESC" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "isCreatedByMe", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "isModifiedByMe", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "scriptEngine", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "isValueNonNullable", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "includeArchived", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2e8567c7-1d7c-4e80-a951-6409e4456eba", "name": "Update Email Template Status", "request": { "name": "Update Email Template Status", "description": { "content": "Performs a state transition on an email template. Required Permissions: Read-Write Assets, Access Design Studio, Approve Email Template.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v2", "emailtemplate", "state", "transition" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "{{access_token}}" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contentId\": \"\",\n \"action\": \"discard\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "57e776bc-4f2c-42ba-be65-d06ee95773b8", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "emailtemplate", "state", "transition" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contentId\": \"\",\n \"action\": \"discard\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"version\": \"\",\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"externalId\": \"\",\n \"scriptEngine\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"version\": \"\",\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"externalId\": \"\",\n \"scriptEngine\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9544ee1-41b2-4abd-97d1-771d81c87ec4", "name": "Error", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "emailtemplate", "state", "transition" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contentId\": \"\",\n \"action\": \"discard\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f9a53b89-c45d-4576-b17f-6d125e9f8e0e", "name": "Get Email Template Used By", "request": { "name": "Get Email Template Used By", "description": { "content": "Returns a list of assets that reference the specified email template. Required Permissions: Read-Only Assets, Access Design Studio.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v2", "emailtemplate", "usedby" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "{{access_token}}" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetId\": \"\",\n \"pageIndex\": \"\",\n \"pageSize\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "2e7b63aa-6a75-4df0-8215-b1dddbc326ee", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "emailtemplate", "usedby" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetId\": \"\",\n \"pageIndex\": \"\",\n \"pageSize\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"channel\": \"\",\n \"contentType\": \"\",\n \"externalId\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"channel\": \"\",\n \"contentType\": \"\",\n \"externalId\": \"\"\n }\n ],\n \"pageDetails\": {\n \"totalItems\": \"\",\n \"pageSize\": \"\",\n \"currentPage\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b052d77-2c9e-47cf-bc5f-fbc671c8e1cf", "name": "Error", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "emailtemplate", "usedby" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetId\": \"\",\n \"pageIndex\": \"\",\n \"pageSize\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d3f9f7b9-e1ec-4f69-9b16-8a9353eaf739", "name": "Get Email Template by Id", "request": { "name": "Get Email Template by Id", "description": { "content": "Retrieves an email template by its ID. Required Permissions: Read-Only Assets, Access Design Studio, Access Email Template.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v2", "emailtemplate", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "{{access_token}}" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "bd18db05-a68e-4d37-87c2-3ca5144a606d", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "emailtemplate", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"version\": \"\",\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"externalId\": \"\",\n \"scriptEngine\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"version\": \"\",\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"externalId\": \"\",\n \"scriptEngine\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1a5d252-e6b3-44ce-9a2a-3014c5132854", "name": "Error", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "emailtemplate", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a5a4142c-5144-45a3-b725-d25360355541", "name": "Delete Email Template", "request": { "name": "Delete Email Template", "description": { "content": "Deletes an email template by its ID. Required Permissions: Read-Write Assets, Access Design Studio, Delete Email Template.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v2", "emailtemplate", ":id", "delete" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "{{access_token}}" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "106946d6-0333-4fde-895c-f5e713abc26e", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "emailtemplate", ":id", "delete" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4fd5107-3320-4ed4-8d68-393caa2ec2c1", "name": "Error", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "emailtemplate", ":id", "delete" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a3fa8d9a-229b-4fc1-b336-5b851edc6166", "name": "Update Email Template", "request": { "name": "Update Email Template", "description": { "content": "Updates an existing email template. Required Permissions: Read-Write Assets, Access Design Studio, Edit Email Template.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v2", "emailtemplate", ":id", "update" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "{{access_token}}" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n },\n \"editorContext\": {\n \"dynamicContent\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "aa585af7-d9e4-4b83-8cc0-6463f34e21cd", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "emailtemplate", ":id", "update" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n },\n \"editorContext\": {\n \"dynamicContent\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"version\": \"\",\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"externalId\": \"\",\n \"scriptEngine\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"version\": \"\",\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"externalId\": \"\",\n \"scriptEngine\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "effa4e55-b003-409b-809b-aceb04e2c7c9", "name": "Error", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "emailtemplate", ":id", "update" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n },\n \"editorContext\": {\n \"dynamicContent\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Fragments (New)", "description": "Reusable content fragments used by the new Email Designer.", "item": [ { "id": "413e2a3b-d56b-484d-a475-31d48b179257", "name": "Create Fragment", "request": { "name": "Create Fragment", "description": { "content": "Creates a new fragment. Required Permissions: Read-Write Assets, Access Design Studio, Edit Snippet.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v2", "fragment" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "{{access_token}}" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"settings\": {\n \"fragmentType\": \"\",\n \"supportedChannels\": [\n \"\",\n \"\"\n ],\n \"fragmentSubType\": \"\"\n },\n \"description\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n },\n \"editorContext\": {\n \"dynamicContent\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "72735180-ed3e-4fb2-b848-a0eed377f0de", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "fragment" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"settings\": {\n \"fragmentType\": \"\",\n \"supportedChannels\": [\n \"\",\n \"\"\n ],\n \"fragmentSubType\": \"\"\n },\n \"description\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n },\n \"editorContext\": {\n \"dynamicContent\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"settings\": {\n \"fragmentType\": \"\",\n \"supportedChannels\": [\n \"\",\n \"\"\n ],\n \"fragmentSubType\": \"\"\n },\n \"thumbnail\": {\n \"url\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"externalId\": \"\",\n \"editorContext\": {\n \"dynamicContent\": {}\n },\n \"scriptEngine\": \"\",\n \"themeId\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"settings\": {\n \"fragmentType\": \"\",\n \"supportedChannels\": [\n \"\",\n \"\"\n ],\n \"fragmentSubType\": \"\"\n },\n \"thumbnail\": {\n \"url\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"externalId\": \"\",\n \"editorContext\": {\n \"dynamicContent\": {}\n },\n \"scriptEngine\": \"\",\n \"themeId\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40cbbc1d-e33c-4ef9-90e4-f591cba31ab0", "name": "Error", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "fragment" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"settings\": {\n \"fragmentType\": \"\",\n \"supportedChannels\": [\n \"\",\n \"\"\n ],\n \"fragmentSubType\": \"\"\n },\n \"description\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n },\n \"editorContext\": {\n \"dynamicContent\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6692d687-2162-4f8a-9e78-ea78bd919abc", "name": "Bulk Delete Fragments", "request": { "name": "Bulk Delete Fragments", "description": { "content": "Deletes multiple fragments by their IDs in a single request. Maximum 20 assets per request. Required Permissions: Read-Write Assets, Access Design Studio, Delete Snippet.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v2", "fragment", "bulk", "delete" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "{{access_token}}" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header", "type": "text/plain" }, "key": "x-app-type", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetIds\": [\n \"\",\n \"\"\n ],\n \"ignoreUsedBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "517d9fc9-9a63-478e-83a2-32a247fde43c", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "fragment", "bulk", "delete" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header", "type": "text/plain" }, "key": "x-app-type", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetIds\": [\n \"\",\n \"\"\n ],\n \"ignoreUsedBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "648d6b89-ce6c-4b0b-981b-c841d723973c", "name": "Error", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "fragment", "bulk", "delete" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header", "type": "text/plain" }, "key": "x-app-type", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetIds\": [\n \"\",\n \"\"\n ],\n \"ignoreUsedBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "03284d3a-559a-474e-aff1-0f2a1035f07a", "name": "Bulk Get Fragments", "request": { "name": "Bulk Get Fragments", "description": { "content": "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.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v2", "fragment", "bulk", "get" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "{{access_token}}" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header", "type": "text/plain" }, "key": "x-app-type", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9510935a-951e-4d26-bc56-cc98c1c1e04a", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "fragment", "bulk", "get" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header", "type": "text/plain" }, "key": "x-app-type", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"settings\": {\n \"fragmentType\": \"\",\n \"supportedChannels\": [\n \"\",\n \"\"\n ],\n \"fragmentSubType\": \"\"\n },\n \"thumbnail\": {\n \"url\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"externalId\": \"\",\n \"editorContext\": {\n \"dynamicContent\": {}\n },\n \"scriptEngine\": \"\",\n \"themeId\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"settings\": {\n \"fragmentType\": \"\",\n \"supportedChannels\": [\n \"\",\n \"\"\n ],\n \"fragmentSubType\": \"\"\n },\n \"thumbnail\": {\n \"url\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"externalId\": \"\",\n \"editorContext\": {\n \"dynamicContent\": {}\n },\n \"scriptEngine\": \"\",\n \"themeId\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61d911e7-b585-4526-82f0-f1b4cc734922", "name": "Error", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "fragment", "bulk", "get" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header", "type": "text/plain" }, "key": "x-app-type", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ef6ea797-f3f7-43b9-a352-4c3841c8e100", "name": "Bulk Get Fragments Used By", "request": { "name": "Bulk Get Fragments Used By", "description": { "content": "Returns, for each of the specified fragments, whether it is used and the number of places it is used (count) \u2014 not the referencing assets themselves. Maximum 50 assets per request. Required Permissions: Read-Only Assets, Access Design Studio.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v2", "fragment", "bulk", "usedby" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "{{access_token}}" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header", "type": "text/plain" }, "key": "x-app-type", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f05116ab-ab0e-4018-8070-d4477a6b0269", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "fragment", "bulk", "usedby" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header", "type": "text/plain" }, "key": "x-app-type", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"count\": \"\",\n \"used\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"count\": \"\",\n \"used\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e543c58-ce56-4a44-a601-de5b0c34d762", "name": "Error", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "fragment", "bulk", "usedby" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header", "type": "text/plain" }, "key": "x-app-type", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e3f5fb00-4123-4488-9ab2-11cb8c8e17ed", "name": "Clone Fragment", "request": { "name": "Clone Fragment", "description": { "content": "Clones an existing fragment. Required Permissions: Read-Write Assets, Access Design Studio, Edit Snippet.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v2", "fragment", "clone" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "{{access_token}}" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetId\": \"\",\n \"newAsset\": {\n \"name\": \"\",\n \"description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "4cdc69bb-ef9d-4fe8-b708-1ae53b231c3e", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "fragment", "clone" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetId\": \"\",\n \"newAsset\": {\n \"name\": \"\",\n \"description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"settings\": {\n \"fragmentType\": \"\",\n \"supportedChannels\": [\n \"\",\n \"\"\n ],\n \"fragmentSubType\": \"\"\n },\n \"thumbnail\": {\n \"url\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"externalId\": \"\",\n \"editorContext\": {\n \"dynamicContent\": {}\n },\n \"scriptEngine\": \"\",\n \"themeId\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"settings\": {\n \"fragmentType\": \"\",\n \"supportedChannels\": [\n \"\",\n \"\"\n ],\n \"fragmentSubType\": \"\"\n },\n \"thumbnail\": {\n \"url\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"externalId\": \"\",\n \"editorContext\": {\n \"dynamicContent\": {}\n },\n \"scriptEngine\": \"\",\n \"themeId\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41711d44-ed1c-4216-a180-4a8eb6f6c157", "name": "Error", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "fragment", "clone" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetId\": \"\",\n \"newAsset\": {\n \"name\": \"\",\n \"description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c841fbbd-78ad-4e0c-9be7-dc8fa7aebaa3", "name": "List Fragments", "request": { "name": "List Fragments", "description": { "content": "Filters and lists fragments by the given criteria. Required Permissions: Read-Only Assets, Access Design Studio, Access Snippet.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v2", "fragment", "filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "{{access_token}}" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "workspaceId", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "folderId", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of Folder,Program)", "type": "text/plain" }, "key": "folderType", "value": "Program" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "pageIndex", "value": "" }, { "disabled": true, "description": { "content": "Maximum value is 50.", "type": "text/plain" }, "key": "pageSize", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "createdAtEnd", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "createdAtStart", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "modifiedAtStart", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "modifiedAtEnd", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "fragmentType", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "sortKey", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of ASC,DESC)", "type": "text/plain" }, "key": "sortOrder", "value": "DESC" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "isCreatedByMe", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "isModifiedByMe", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "scriptEngine", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "isValueNonNullable", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "includeArchived", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "edd6cf08-5f66-4619-8b4f-979f2bc31306", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "fragment", "filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "workspaceId", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "folderId", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of Folder,Program)", "type": "text/plain" }, "key": "folderType", "value": "Program" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "pageIndex", "value": "" }, { "disabled": true, "description": { "content": "Maximum value is 50.", "type": "text/plain" }, "key": "pageSize", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "createdAtEnd", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "createdAtStart", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "modifiedAtStart", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "modifiedAtEnd", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "fragmentType", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "sortKey", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of ASC,DESC)", "type": "text/plain" }, "key": "sortOrder", "value": "DESC" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "isCreatedByMe", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "isModifiedByMe", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "scriptEngine", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "isValueNonNullable", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "includeArchived", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"result\": {\n \"totalItems\": \"\",\n \"pageSize\": \"\",\n \"currentPage\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"settings\": {\n \"fragmentType\": \"\",\n \"supportedChannels\": [\n \"\",\n \"\"\n ],\n \"fragmentSubType\": \"\"\n },\n \"thumbnail\": {\n \"url\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"externalId\": \"\",\n \"editorContext\": {\n \"dynamicContent\": {}\n },\n \"scriptEngine\": \"\",\n \"themeId\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"settings\": {\n \"fragmentType\": \"\",\n \"supportedChannels\": [\n \"\",\n \"\"\n ],\n \"fragmentSubType\": \"\"\n },\n \"thumbnail\": {\n \"url\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"externalId\": \"\",\n \"editorContext\": {\n \"dynamicContent\": {}\n },\n \"scriptEngine\": \"\",\n \"themeId\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9a63cd4-c6c3-4abb-9269-17c3aafcc3ec", "name": "Error", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "fragment", "filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "workspaceId", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "folderId", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of Folder,Program)", "type": "text/plain" }, "key": "folderType", "value": "Program" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "pageIndex", "value": "" }, { "disabled": true, "description": { "content": "Maximum value is 50.", "type": "text/plain" }, "key": "pageSize", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "createdAtEnd", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "createdAtStart", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "modifiedAtStart", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "modifiedAtEnd", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "fragmentType", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "sortKey", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of ASC,DESC)", "type": "text/plain" }, "key": "sortOrder", "value": "DESC" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "isCreatedByMe", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "isModifiedByMe", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "scriptEngine", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "isValueNonNullable", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "includeArchived", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e9aea3de-6a81-48a9-9822-c700505e2790", "name": "Update Fragment Status", "request": { "name": "Update Fragment Status", "description": { "content": "Performs a state transition on a fragment. Required Permissions: Read-Write Assets, Access Design Studio, Approve Snippet.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v2", "fragment", "state", "transition" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "{{access_token}}" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contentId\": \"\",\n \"action\": \"discard\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "8dd69e4a-0fae-42ec-9058-edffa3d32f7c", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "fragment", "state", "transition" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contentId\": \"\",\n \"action\": \"discard\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"settings\": {\n \"fragmentType\": \"\",\n \"supportedChannels\": [\n \"\",\n \"\"\n ],\n \"fragmentSubType\": \"\"\n },\n \"thumbnail\": {\n \"url\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"externalId\": \"\",\n \"editorContext\": {\n \"dynamicContent\": {}\n },\n \"scriptEngine\": \"\",\n \"themeId\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"settings\": {\n \"fragmentType\": \"\",\n \"supportedChannels\": [\n \"\",\n \"\"\n ],\n \"fragmentSubType\": \"\"\n },\n \"thumbnail\": {\n \"url\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"externalId\": \"\",\n \"editorContext\": {\n \"dynamicContent\": {}\n },\n \"scriptEngine\": \"\",\n \"themeId\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4d827be-a638-45b5-92d2-bb7e89d0bd1d", "name": "Error", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "fragment", "state", "transition" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contentId\": \"\",\n \"action\": \"discard\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "392c992b-b8ec-4f9c-ad10-1d505e90bf20", "name": "Get Fragment Used By", "request": { "name": "Get Fragment Used By", "description": { "content": "Returns a list of assets that reference the specified fragment. Required Permissions: Read-Only Assets, Access Design Studio.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v2", "fragment", "usedby" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "{{access_token}}" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetId\": \"\",\n \"pageIndex\": \"\",\n \"pageSize\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "683a8f6d-60b3-4476-aabc-4c414dcdb628", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "fragment", "usedby" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetId\": \"\",\n \"pageIndex\": \"\",\n \"pageSize\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"channel\": \"\",\n \"contentType\": \"\",\n \"externalId\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"channel\": \"\",\n \"contentType\": \"\",\n \"externalId\": \"\"\n }\n ],\n \"pageDetails\": {\n \"totalItems\": \"\",\n \"pageSize\": \"\",\n \"currentPage\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1c12ece-bbcc-4b27-9ea8-7224d2b6b108", "name": "Error", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "fragment", "usedby" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetId\": \"\",\n \"pageIndex\": \"\",\n \"pageSize\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2115a9f9-0eb2-4988-9312-c7d219c55539", "name": "Get Fragment by Id", "request": { "name": "Get Fragment by Id", "description": { "content": "Retrieves a fragment by its ID. Required Permissions: Read-Only Assets, Access Design Studio, Access Snippet.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v2", "fragment", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "{{access_token}}" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2a1924ba-478f-4145-80ef-863c8f878d41", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "fragment", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"settings\": {\n \"fragmentType\": \"\",\n \"supportedChannels\": [\n \"\",\n \"\"\n ],\n \"fragmentSubType\": \"\"\n },\n \"thumbnail\": {\n \"url\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"externalId\": \"\",\n \"editorContext\": {\n \"dynamicContent\": {}\n },\n \"scriptEngine\": \"\",\n \"themeId\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"settings\": {\n \"fragmentType\": \"\",\n \"supportedChannels\": [\n \"\",\n \"\"\n ],\n \"fragmentSubType\": \"\"\n },\n \"thumbnail\": {\n \"url\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"externalId\": \"\",\n \"editorContext\": {\n \"dynamicContent\": {}\n },\n \"scriptEngine\": \"\",\n \"themeId\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d53048c-7bd5-4b3b-915d-b8bab07d0814", "name": "Error", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "fragment", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f1a649d3-2845-4c98-bac3-65cd4dde0acf", "name": "Delete Fragment", "request": { "name": "Delete Fragment", "description": { "content": "Deletes a fragment by its ID. Required Permissions: Read-Write Assets, Access Design Studio, Delete Snippet.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v2", "fragment", ":id", "delete" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "{{access_token}}" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "12e958d3-352b-48f9-aa54-7b3499beef6a", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "fragment", ":id", "delete" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05dd4869-f9a8-45c8-a340-a9ad5e58cc7f", "name": "Error", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "fragment", ":id", "delete" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "02198104-9a85-460a-b3fd-de8d7f5ae7f3", "name": "Update Fragment", "request": { "name": "Update Fragment", "description": { "content": "Updates an existing fragment. Required Permissions: Read-Write Assets, Access Design Studio, Edit Snippet.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v2", "fragment", ":id", "update" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "{{access_token}}" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n },\n \"editorContext\": {\n \"dynamicContent\": {}\n },\n \"settings\": {\n \"fragmentType\": \"\",\n \"fragmentSubType\": \"\",\n \"supportedChannels\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "70f33113-776c-4905-9f03-15b2ae70bb61", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "fragment", ":id", "update" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n },\n \"editorContext\": {\n \"dynamicContent\": {}\n },\n \"settings\": {\n \"fragmentType\": \"\",\n \"fragmentSubType\": \"\",\n \"supportedChannels\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"settings\": {\n \"fragmentType\": \"\",\n \"supportedChannels\": [\n \"\",\n \"\"\n ],\n \"fragmentSubType\": \"\"\n },\n \"thumbnail\": {\n \"url\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"externalId\": \"\",\n \"editorContext\": {\n \"dynamicContent\": {}\n },\n \"scriptEngine\": \"\",\n \"themeId\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appType\": \"\",\n \"metadata\": {\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"createdById\": \"\",\n \"createdByAepId\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedById\": \"\",\n \"modifiedByAepId\": \"\"\n },\n \"settings\": {\n \"fragmentType\": \"\",\n \"supportedChannels\": [\n \"\",\n \"\"\n ],\n \"fragmentSubType\": \"\"\n },\n \"thumbnail\": {\n \"url\": \"\"\n },\n \"status\": \"\",\n \"state\": \"\",\n \"virtualId\": \"\",\n \"associatedStates\": [\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n },\n {\n \"contentId\": \"\",\n \"externalId\": \"\",\n \"state\": \"\"\n }\n ],\n \"appData\": {\n \"editorType\": \"\",\n \"folderId\": \"\",\n \"workspaceId\": \"\"\n },\n \"externalId\": \"\",\n \"editorContext\": {\n \"dynamicContent\": {}\n },\n \"scriptEngine\": \"\",\n \"themeId\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb804b87-a543-4e38-80aa-9d8bf4b15c7f", "name": "Error", "originalRequest": { "url": { "path": [ "rest", "asset", "v2", "fragment", ":id", "update" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Token for Authorization", "type": "text/plain" }, "key": "access_token", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Application type header (This can only be one of marketo)", "type": "text/plain" }, "key": "x-app-type", "value": "marketo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"data\": {\n \"html\": {\n \"body\": \"\"\n },\n \"text\": {\n \"body\": \"\",\n \"syncFromHtml\": \"\"\n }\n },\n \"editorContext\": {\n \"dynamicContent\": {}\n },\n \"settings\": {\n \"fragmentType\": \"\",\n \"fragmentSubType\": \"\",\n \"supportedChannels\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"requestId\": \"\",\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"code\": \"\",\n \"dynamicMessage\": \"\",\n \"type\": \"\",\n \"source\": \"\",\n \"errorMessage\": \"\",\n \"errorPosition\": {\n \"line\": \"\",\n \"column\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Landing Pages", "description": "CRUD operations on landing pages, including approval, cloning, and dynamic content.", "item": [ { "id": "193cdedf-73b5-4a39-a5cb-2437ee61dd67", "name": "Get Landing Page by Name", "request": { "name": "Get Landing Page by Name", "description": { "content": "Returns the landing page record for the given name. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "landingPage", "byName.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Name of the landing page", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" }, { "disabled": true, "description": { "content": "Maximum number of records to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "019e3841-52ad-4b36-9cc6-c25cc5ccab9a", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "landingPage", "byName.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Name of the landing page", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" }, { "disabled": true, "description": { "content": "Maximum number of records to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"customHeadHTML\": \"\",\n \"facebookOgTags\": \"\",\n \"robots\": \"\",\n \"title\": \"\",\n \"URL\": \"\",\n \"computedUrl\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"formPrefill\": \"\",\n \"id\": \"\",\n \"keywords\": \"\",\n \"mobileEnabled\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"template\": \"\",\n \"updatedAt\": \"\",\n \"workspace\": \"\"\n },\n {\n \"customHeadHTML\": \"\",\n \"facebookOgTags\": \"\",\n \"robots\": \"\",\n \"title\": \"\",\n \"URL\": \"\",\n \"computedUrl\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"formPrefill\": \"\",\n \"id\": \"\",\n \"keywords\": \"\",\n \"mobileEnabled\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"template\": \"\",\n \"updatedAt\": \"\",\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "887691e1-3919-4c0b-b5a8-647e9a8d9a6b", "name": "Get Landing Page by Id", "request": { "name": "Get Landing Page by Id", "description": { "content": "Returns the landing record for the given id. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "landingPage", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "32e3ae2c-a2fb-449c-85db-062c34c6d464", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "landingPage", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"customHeadHTML\": \"\",\n \"facebookOgTags\": \"\",\n \"robots\": \"\",\n \"title\": \"\",\n \"URL\": \"\",\n \"computedUrl\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"formPrefill\": \"\",\n \"id\": \"\",\n \"keywords\": \"\",\n \"mobileEnabled\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"template\": \"\",\n \"updatedAt\": \"\",\n \"workspace\": \"\"\n },\n {\n \"customHeadHTML\": \"\",\n \"facebookOgTags\": \"\",\n \"robots\": \"\",\n \"title\": \"\",\n \"URL\": \"\",\n \"computedUrl\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"formPrefill\": \"\",\n \"id\": \"\",\n \"keywords\": \"\",\n \"mobileEnabled\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"template\": \"\",\n \"updatedAt\": \"\",\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7bab14ab-ed3c-4493-97e0-dedeb2e3904a", "name": "Update Landing Page Metadata", "request": { "name": "Update Landing Page Metadata", "description": { "content": "Updates the metadata for the targe landing page. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "landingPage", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "Any custom HTML to embed in the tag of the page", "type": "text/plain" }, "key": "customHeadHTML", "value": "" }, { "disabled": true, "description": { "content": "Description of the asset", "type": "text/plain" }, "key": "description", "value": "" }, { "disabled": true, "description": { "content": "Any OpenGraph meta tags to apply to the page", "type": "text/plain" }, "key": "facebookOgTags", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "keywords", "value": "" }, { "disabled": true, "description": { "content": "Meta description property of the page", "type": "text/plain" }, "key": "metaTagsDescription", "value": "" }, { "disabled": true, "description": { "content": "Whether the page has mobile viewing enabled. Free-form pages only. Default false", "type": "text/plain" }, "key": "mobileEnabled", "value": "" }, { "disabled": true, "description": { "content": "Name of the landing page", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Robots directives to apply to the pages meta tags", "type": "text/plain" }, "key": "robots", "value": "" }, { "disabled": true, "description": { "content": "Additional CSS styles to append to the landing page ", "type": "text/plain" }, "key": "styleOverRide", "value": "" }, { "disabled": true, "description": { "content": "Title element of the landing page", "type": "text/plain" }, "key": "title", "value": "" }, { "disabled": true, "description": { "content": "URL path of the page. Derived from the name field if unset", "type": "text/plain" }, "key": "urlPageName", "value": "" } ] }, "auth": null }, "response": [ { "id": "364a8db6-78c0-4ad7-9060-0ecedd5bdf4a", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "landingPage", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "Any custom HTML to embed in the tag of the page", "type": "text/plain" }, "key": "customHeadHTML", "value": "" }, { "disabled": true, "description": { "content": "Description of the asset", "type": "text/plain" }, "key": "description", "value": "" }, { "disabled": true, "description": { "content": "Any OpenGraph meta tags to apply to the page", "type": "text/plain" }, "key": "facebookOgTags", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "keywords", "value": "" }, { "disabled": true, "description": { "content": "Meta description property of the page", "type": "text/plain" }, "key": "metaTagsDescription", "value": "" }, { "disabled": true, "description": { "content": "Whether the page has mobile viewing enabled. Free-form pages only. Default false", "type": "text/plain" }, "key": "mobileEnabled", "value": "" }, { "disabled": true, "description": { "content": "Name of the landing page", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Robots directives to apply to the pages meta tags", "type": "text/plain" }, "key": "robots", "value": "" }, { "disabled": true, "description": { "content": "Additional CSS styles to append to the landing page ", "type": "text/plain" }, "key": "styleOverRide", "value": "" }, { "disabled": true, "description": { "content": "Title element of the landing page", "type": "text/plain" }, "key": "title", "value": "" }, { "disabled": true, "description": { "content": "URL path of the page. Derived from the name field if unset", "type": "text/plain" }, "key": "urlPageName", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"customHeadHTML\": \"\",\n \"facebookOgTags\": \"\",\n \"robots\": \"\",\n \"title\": \"\",\n \"URL\": \"\",\n \"computedUrl\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"formPrefill\": \"\",\n \"id\": \"\",\n \"keywords\": \"\",\n \"mobileEnabled\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"template\": \"\",\n \"updatedAt\": \"\",\n \"workspace\": \"\"\n },\n {\n \"customHeadHTML\": \"\",\n \"facebookOgTags\": \"\",\n \"robots\": \"\",\n \"title\": \"\",\n \"URL\": \"\",\n \"computedUrl\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"formPrefill\": \"\",\n \"id\": \"\",\n \"keywords\": \"\",\n \"mobileEnabled\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"template\": \"\",\n \"updatedAt\": \"\",\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e7f84bd4-1952-4b0c-90b2-b60488d88b84", "name": "Approve Landing Page Draft", "request": { "name": "Approve Landing Page Draft", "description": { "content": "Approves the current draft of the landing page. Required Permissions: Approve Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "landingPage", ":id", "approveDraft.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "5925edaf-d8b8-402b-b0c8-b1ca56928e66", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "landingPage", ":id", "approveDraft.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a772e448-1b1f-4d1f-bc3e-69f894ba9240", "name": "Clone Landing Page", "request": { "name": "Clone Landing Page", "description": { "content": "Clones the target landing page. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "landingPage", ":id", "clone.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "type", "value": "Program" }, { "disabled": false, "description": { "content": "(Required) Name of the landing page", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Description of the asset", "type": "text/plain" }, "key": "description", "value": "" }, { "disabled": true, "description": { "content": "Id of the template used", "type": "text/plain" }, "key": "template", "value": "" } ] }, "auth": null }, "response": [ { "id": "39ec5c0c-4db1-4dd7-8809-8eb762ec9422", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "landingPage", ":id", "clone.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "type", "value": "Program" }, { "disabled": false, "description": { "content": "(Required) Name of the landing page", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Description of the asset", "type": "text/plain" }, "key": "description", "value": "" }, { "disabled": true, "description": { "content": "Id of the template used", "type": "text/plain" }, "key": "template", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"customHeadHTML\": \"\",\n \"facebookOgTags\": \"\",\n \"robots\": \"\",\n \"title\": \"\",\n \"URL\": \"\",\n \"computedUrl\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"formPrefill\": \"\",\n \"id\": \"\",\n \"keywords\": \"\",\n \"mobileEnabled\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"template\": \"\",\n \"updatedAt\": \"\",\n \"workspace\": \"\"\n },\n {\n \"customHeadHTML\": \"\",\n \"facebookOgTags\": \"\",\n \"robots\": \"\",\n \"title\": \"\",\n \"URL\": \"\",\n \"computedUrl\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"formPrefill\": \"\",\n \"id\": \"\",\n \"keywords\": \"\",\n \"mobileEnabled\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"template\": \"\",\n \"updatedAt\": \"\",\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "50b2094b-b587-4488-8f9e-708e0a0e0d29", "name": "Delete Landing Page", "request": { "name": "Delete Landing Page", "description": { "content": "Deletes the target landing page. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "landingPage", ":id", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "03511fe3-b4d7-401a-8bb2-bbdefa65ccd4", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "landingPage", ":id", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "00e1a893-e363-4fb2-89cb-633438b3f134", "name": "Discard Landing Page Draft", "request": { "name": "Discard Landing Page Draft", "description": { "content": "Discards the current draft of the landing page. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "landingPage", ":id", "discardDraft.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "634253eb-b5c1-46a4-a526-8301887a7916", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "landingPage", ":id", "discardDraft.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e3379ab4-d05d-40e4-9b22-4a814b8d2ec3", "name": "Get Landing Page Full Content", "request": { "name": "Get Landing Page Full Content", "description": { "content": "Returns the serialized HTML version of the landing page. Required Permissions: Read-Only Assets, Read-Write Assets. If leadId is passed in the request: Read-Only Lead, Read-Write Lead.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "landingPage", ":id", "fullContent.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "The lead id to impersonate. Landing page is rendered as though it was viewed by this lead.", "type": "text/plain" }, "key": "leadId", "value": "" }, { "disabled": true, "description": { "content": "JSON array of of segmentations. Each segmentation must be a JSON object with members 'segmentationId', and 'segmentId'.
Example: [{\"segmentationId\":1030,\"segmentId\":1103}]", "type": "text/plain" }, "key": "segmentation", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Id of the landing page.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "5f292b2b-ee26-45eb-b92f-33f56d7ef79c", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "landingPage", ":id", "fullContent.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "The lead id to impersonate. Landing page is rendered as though it was viewed by this lead.", "type": "text/plain" }, "key": "leadId", "value": "" }, { "disabled": true, "description": { "content": "JSON array of of segmentations. Each segmentation must be a JSON object with members 'segmentationId', and 'segmentId'.
Example: [{\"segmentationId\":1030,\"segmentId\":1103}]", "type": "text/plain" }, "key": "segmentation", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the landing page.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"content\": \"\",\n \"id\": \"\"\n },\n {\n \"content\": \"\",\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2f7e8dd7-7782-4d08-be51-518c56803c92", "name": "Unapprove Landing Page", "request": { "name": "Unapprove Landing Page", "description": { "content": "Unapproves the landing page, reverting it to a draft-only state. Required Permissions: Approve Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "landingPage", ":id", "unapprove.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "ed165b63-0876-4f57-9c08-3d8cb837f3cc", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "landingPage", ":id", "unapprove.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"customHeadHTML\": \"\",\n \"facebookOgTags\": \"\",\n \"robots\": \"\",\n \"title\": \"\",\n \"URL\": \"\",\n \"computedUrl\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"formPrefill\": \"\",\n \"id\": \"\",\n \"keywords\": \"\",\n \"mobileEnabled\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"template\": \"\",\n \"updatedAt\": \"\",\n \"workspace\": \"\"\n },\n {\n \"customHeadHTML\": \"\",\n \"facebookOgTags\": \"\",\n \"robots\": \"\",\n \"title\": \"\",\n \"URL\": \"\",\n \"computedUrl\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"formPrefill\": \"\",\n \"id\": \"\",\n \"keywords\": \"\",\n \"mobileEnabled\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"template\": \"\",\n \"updatedAt\": \"\",\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2297ef64-3f72-408e-a99c-368fa1887ebb", "name": "Update Landing Page Variable", "request": { "name": "Update Landing Page Variable", "description": { "content": "Updates the value of the given variable. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "landingPage", ":id", "variable", "{{variableId}}.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) New value of the variable", "type": "text/plain" }, "key": "value", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "55f3a331-f454-46f9-b0c0-bad5530f3b22", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "landingPage", ":id", "variable", "{{variableId}}.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) New value of the variable", "type": "text/plain" }, "key": "value", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"value\": {}\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"value\": {}\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "abc9f113-029c-41b4-92fb-9e433049797d", "name": "Get Landing Page Variables", "request": { "name": "Get Landing Page Variables", "description": {}, "url": { "path": [ "rest", "asset", "v1", "landingPage", ":id", "variables.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Id of the landing page", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9691a214-5a65-487b-a891-f5926463d9e8", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "landingPage", ":id", "variables.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the landing page", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"value\": {}\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"value\": {}\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "576bf8de-885e-4e82-a6d7-9be02530699f", "name": "Get Landing Pages", "request": { "name": "Get Landing Pages", "description": { "content": "Retrieves a list of accessible landing pages from the target instance. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "landingPages.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" }, { "disabled": true, "description": { "content": "Maximum number of landing pages to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "folder", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4db2d6b4-1a7a-44fa-9e0d-075124c3d38a", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "landingPages.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" }, { "disabled": true, "description": { "content": "Maximum number of landing pages to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "folder", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"customHeadHTML\": \"\",\n \"facebookOgTags\": \"\",\n \"robots\": \"\",\n \"title\": \"\",\n \"URL\": \"\",\n \"computedUrl\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"formPrefill\": \"\",\n \"id\": \"\",\n \"keywords\": \"\",\n \"mobileEnabled\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"template\": \"\",\n \"updatedAt\": \"\",\n \"workspace\": \"\"\n },\n {\n \"customHeadHTML\": \"\",\n \"facebookOgTags\": \"\",\n \"robots\": \"\",\n \"title\": \"\",\n \"URL\": \"\",\n \"computedUrl\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"formPrefill\": \"\",\n \"id\": \"\",\n \"keywords\": \"\",\n \"mobileEnabled\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"template\": \"\",\n \"updatedAt\": \"\",\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1c9619f8-e2f1-4b2b-9f63-d4893c7526ac", "name": "Create Landing Page", "request": { "name": "Create Landing Page", "description": { "content": "Creates a new landing page. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "landingPages.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "type", "value": "Program" }, { "disabled": false, "description": { "content": "(Required) Name of the landing page", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": false, "description": { "content": "(Required) Id of the template used", "type": "text/plain" }, "key": "template", "value": "" }, { "disabled": true, "description": { "content": "Any custom HTML to embed in the tag of the page", "type": "text/plain" }, "key": "customHeadHTML", "value": "" }, { "disabled": true, "description": { "content": "Description of the asset", "type": "text/plain" }, "key": "description", "value": "" }, { "disabled": true, "description": { "content": "Any OpenGraph meta tags to apply to the page", "type": "text/plain" }, "key": "facebookOgTags", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "keywords", "value": "" }, { "disabled": true, "description": { "content": "Whether the page has mobile viewing enabled. Free-form pages only. Default false", "type": "text/plain" }, "key": "mobileEnabled", "value": "" }, { "disabled": true, "description": { "content": "Boolean to toggle whether forms embedded in the page will prefill. Default false", "type": "text/plain" }, "key": "prefillForm", "value": "" }, { "disabled": true, "description": { "content": "Robots directives to apply to the pages meta tags", "type": "text/plain" }, "key": "robots", "value": "" }, { "disabled": true, "description": { "content": "Title element of the landing page", "type": "text/plain" }, "key": "title", "value": "" }, { "disabled": true, "description": { "content": "URL path of the page. Derived from the name field if unset", "type": "text/plain" }, "key": "urlPageName", "value": "" }, { "disabled": true, "description": { "content": "Name of the workspace", "type": "text/plain" }, "key": "workspace", "value": "" } ] }, "auth": null }, "response": [ { "id": "9b2d5143-9b04-4f45-8e69-c3dd91265113", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "landingPages.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "type", "value": "Program" }, { "disabled": false, "description": { "content": "(Required) Name of the landing page", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": false, "description": { "content": "(Required) Id of the template used", "type": "text/plain" }, "key": "template", "value": "" }, { "disabled": true, "description": { "content": "Any custom HTML to embed in the tag of the page", "type": "text/plain" }, "key": "customHeadHTML", "value": "" }, { "disabled": true, "description": { "content": "Description of the asset", "type": "text/plain" }, "key": "description", "value": "" }, { "disabled": true, "description": { "content": "Any OpenGraph meta tags to apply to the page", "type": "text/plain" }, "key": "facebookOgTags", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "keywords", "value": "" }, { "disabled": true, "description": { "content": "Whether the page has mobile viewing enabled. Free-form pages only. Default false", "type": "text/plain" }, "key": "mobileEnabled", "value": "" }, { "disabled": true, "description": { "content": "Boolean to toggle whether forms embedded in the page will prefill. Default false", "type": "text/plain" }, "key": "prefillForm", "value": "" }, { "disabled": true, "description": { "content": "Robots directives to apply to the pages meta tags", "type": "text/plain" }, "key": "robots", "value": "" }, { "disabled": true, "description": { "content": "Title element of the landing page", "type": "text/plain" }, "key": "title", "value": "" }, { "disabled": true, "description": { "content": "URL path of the page. Derived from the name field if unset", "type": "text/plain" }, "key": "urlPageName", "value": "" }, { "disabled": true, "description": { "content": "Name of the workspace", "type": "text/plain" }, "key": "workspace", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"customHeadHTML\": \"\",\n \"facebookOgTags\": \"\",\n \"robots\": \"\",\n \"title\": \"\",\n \"URL\": \"\",\n \"computedUrl\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"formPrefill\": \"\",\n \"id\": \"\",\n \"keywords\": \"\",\n \"mobileEnabled\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"template\": \"\",\n \"updatedAt\": \"\",\n \"workspace\": \"\"\n },\n {\n \"customHeadHTML\": \"\",\n \"facebookOgTags\": \"\",\n \"robots\": \"\",\n \"title\": \"\",\n \"URL\": \"\",\n \"computedUrl\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"formPrefill\": \"\",\n \"id\": \"\",\n \"keywords\": \"\",\n \"mobileEnabled\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"template\": \"\",\n \"updatedAt\": \"\",\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Landing Page Content", "description": "Manage the content sections (rich text, forms, images, HTML) placed on a landing page.", "item": [ { "id": "abd54763-e914-42a8-a783-cc377fb0416c", "name": "Get Landing Page Content", "request": { "name": "Get Landing Page Content", "description": { "content": "Retrieves the list of content sections in the target landing page. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "landingPage", ":id", "content.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f69ead1b-45a7-4412-bc50-53d871c9ee21", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "landingPage", ":id", "content.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": {},\n \"type\": \"Form\",\n \"content\": {},\n \"followupType\": \"formDefined\",\n \"followupValue\": \"\",\n \"formattingOptions\": {\n \"array\": \"\",\n \"bigDecimal\": \"\",\n \"bigInteger\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"containerNode\": \"\",\n \"double\": \"\",\n \"float\": \"\",\n \"floatingPointNumber\": \"\",\n \"int\": \"\",\n \"integralNumber\": \"\",\n \"long\": \"\",\n \"missingNode\": \"\",\n \"nodeType\": \"BOOLEAN\",\n \"null\": \"\",\n \"number\": \"\",\n \"object\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"textual\": \"\",\n \"valueNode\": \"\"\n },\n \"index\": \"\"\n },\n {\n \"id\": {},\n \"type\": \"Video\",\n \"content\": {},\n \"followupType\": \"formDefined\",\n \"followupValue\": \"\",\n \"formattingOptions\": {\n \"array\": \"\",\n \"bigDecimal\": \"\",\n \"bigInteger\": \"\",\n \"binary\": \"\",\n \"boolean\": \"\",\n \"containerNode\": \"\",\n \"double\": \"\",\n \"float\": \"\",\n \"floatingPointNumber\": \"\",\n \"int\": \"\",\n \"integralNumber\": \"\",\n \"long\": \"\",\n \"missingNode\": \"\",\n \"nodeType\": \"NUMBER\",\n \"null\": \"\",\n \"number\": \"\",\n \"object\": \"\",\n \"pojo\": \"\",\n \"short\": \"\",\n \"textual\": \"\",\n \"valueNode\": \"\"\n },\n \"index\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f542e1e0-7528-41b2-aa07-162b88ca925c", "name": "Add Landing Page Content Section", "request": { "name": "Add Landing Page Content Section", "description": { "content": "Adds a content section to the target landing page. Parameters must be sent as application/x-www-form-urlencoded (not JSON). Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "landingPage", ":id", "content.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Id of the content section. Also the HTML id of the section.", "type": "text/plain" }, "key": "contentId", "value": "" }, { "disabled": false, "description": { "content": "(Required) Type of content section", "type": "text/plain" }, "key": "type", "value": "Snippet" }, { "disabled": true, "description": { "content": "background-color property of the HTML section", "type": "text/plain" }, "key": "backgroundColor", "value": "" }, { "disabled": true, "description": { "content": "border-color property of the HTML section", "type": "text/plain" }, "key": "borderColor", "value": "" }, { "disabled": true, "description": { "content": "border-style property of the HTML section", "type": "text/plain" }, "key": "borderStyle", "value": "" }, { "disabled": true, "description": { "content": "border-width property of the HTML section", "type": "text/plain" }, "key": "borderWidth", "value": "" }, { "disabled": true, "description": { "content": "height property of the HTML section", "type": "text/plain" }, "key": "height", "value": "" }, { "disabled": true, "description": { "content": "Hide the section when displayed on a desktop browser. Default false", "type": "text/plain" }, "key": "hideDesktop", "value": "" }, { "disabled": true, "description": { "content": "Hide the section when displayed on a mobile browser. Default false", "type": "text/plain" }, "key": "hideMobile", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "imageOpenNewWindow", "value": "" }, { "disabled": true, "description": { "content": "left property of the HTML section", "type": "text/plain" }, "key": "left", "value": "" }, { "disabled": true, "description": { "content": "URL parameter of a link type section", "type": "text/plain" }, "key": "linkUrl", "value": "" }, { "disabled": true, "description": { "content": "opacity property of the HTML section", "type": "text/plain" }, "key": "opacity", "value": "" }, { "disabled": true, "description": { "content": "top property of the HTML section", "type": "text/plain" }, "key": "top", "value": "" }, { "disabled": true, "description": { "content": "Type of content section", "type": "text/plain" }, "key": "value", "value": "" }, { "disabled": true, "description": { "content": "width property of the HTML section", "type": "text/plain" }, "key": "width", "value": "" }, { "disabled": true, "description": { "content": "z-index property of the HTML section", "type": "text/plain" }, "key": "zIndex", "value": "" } ] }, "auth": null }, "response": [ { "id": "a728980d-5e8f-4cc6-ac13-eea0ab5ab3ae", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "landingPage", ":id", "content.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Id of the content section. Also the HTML id of the section.", "type": "text/plain" }, "key": "contentId", "value": "" }, { "disabled": false, "description": { "content": "(Required) Type of content section", "type": "text/plain" }, "key": "type", "value": "Snippet" }, { "disabled": true, "description": { "content": "background-color property of the HTML section", "type": "text/plain" }, "key": "backgroundColor", "value": "" }, { "disabled": true, "description": { "content": "border-color property of the HTML section", "type": "text/plain" }, "key": "borderColor", "value": "" }, { "disabled": true, "description": { "content": "border-style property of the HTML section", "type": "text/plain" }, "key": "borderStyle", "value": "" }, { "disabled": true, "description": { "content": "border-width property of the HTML section", "type": "text/plain" }, "key": "borderWidth", "value": "" }, { "disabled": true, "description": { "content": "height property of the HTML section", "type": "text/plain" }, "key": "height", "value": "" }, { "disabled": true, "description": { "content": "Hide the section when displayed on a desktop browser. Default false", "type": "text/plain" }, "key": "hideDesktop", "value": "" }, { "disabled": true, "description": { "content": "Hide the section when displayed on a mobile browser. Default false", "type": "text/plain" }, "key": "hideMobile", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "imageOpenNewWindow", "value": "" }, { "disabled": true, "description": { "content": "left property of the HTML section", "type": "text/plain" }, "key": "left", "value": "" }, { "disabled": true, "description": { "content": "URL parameter of a link type section", "type": "text/plain" }, "key": "linkUrl", "value": "" }, { "disabled": true, "description": { "content": "opacity property of the HTML section", "type": "text/plain" }, "key": "opacity", "value": "" }, { "disabled": true, "description": { "content": "top property of the HTML section", "type": "text/plain" }, "key": "top", "value": "" }, { "disabled": true, "description": { "content": "Type of content section", "type": "text/plain" }, "key": "value", "value": "" }, { "disabled": true, "description": { "content": "width property of the HTML section", "type": "text/plain" }, "key": "width", "value": "" }, { "disabled": true, "description": { "content": "z-index property of the HTML section", "type": "text/plain" }, "key": "zIndex", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "00ffcc05-87d5-4d8a-9326-080df9cb0b6d", "name": "Update Landing Page Content Section", "request": { "name": "Update Landing Page Content Section", "description": { "content": "Updates a content section the landing page. Parameters must be sent as application/x-www-form-urlencoded (not JSON). Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "landingPage", ":id", "content", "{{contentId}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Id of landing page", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Type of content section", "type": "text/plain" }, "key": "type", "value": "Rectangle" }, { "disabled": true, "description": { "content": "background-color property of the HTML section", "type": "text/plain" }, "key": "backgroundColor", "value": "" }, { "disabled": true, "description": { "content": "border-color property of the HTML section", "type": "text/plain" }, "key": "borderColor", "value": "" }, { "disabled": true, "description": { "content": "border-style property of the HTML section", "type": "text/plain" }, "key": "borderStyle", "value": "" }, { "disabled": true, "description": { "content": "border-width property of the HTML section", "type": "text/plain" }, "key": "borderWidth", "value": "" }, { "disabled": true, "description": { "content": "height property of the HTML section", "type": "text/plain" }, "key": "height", "value": "" }, { "disabled": true, "description": { "content": "Hide the section when displayed on a desktop browser. Default false", "type": "text/plain" }, "key": "hideDesktop", "value": "" }, { "disabled": true, "description": { "content": "Hide the section when displayed on a mobile browser. Default false", "type": "text/plain" }, "key": "hideMobile", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "imageOpenNewWindow", "value": "" }, { "disabled": true, "description": { "content": "Index of the content section. Determines the order of the section in the landing page", "type": "text/plain" }, "key": "index", "value": "" }, { "disabled": true, "description": { "content": "left property of the HTML section", "type": "text/plain" }, "key": "left", "value": "" }, { "disabled": true, "description": { "content": "URL parameter of a link type section", "type": "text/plain" }, "key": "linkUrl", "value": "" }, { "disabled": true, "description": { "content": "opacity property of the HTML section", "type": "text/plain" }, "key": "opacity", "value": "" }, { "disabled": true, "description": { "content": "top property of the HTML section", "type": "text/plain" }, "key": "top", "value": "" }, { "disabled": true, "description": { "content": "Type of content section", "type": "text/plain" }, "key": "value", "value": "" }, { "disabled": true, "description": { "content": "width property of the HTML section", "type": "text/plain" }, "key": "width", "value": "" }, { "disabled": true, "description": { "content": "z-index property of the HTML section", "type": "text/plain" }, "key": "zIndex", "value": "" } ] }, "auth": null }, "response": [ { "id": "1510eb14-127c-4b9a-91e2-b8cc77bce860", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "landingPage", ":id", "content", "{{contentId}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of landing page", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Type of content section", "type": "text/plain" }, "key": "type", "value": "Rectangle" }, { "disabled": true, "description": { "content": "background-color property of the HTML section", "type": "text/plain" }, "key": "backgroundColor", "value": "" }, { "disabled": true, "description": { "content": "border-color property of the HTML section", "type": "text/plain" }, "key": "borderColor", "value": "" }, { "disabled": true, "description": { "content": "border-style property of the HTML section", "type": "text/plain" }, "key": "borderStyle", "value": "" }, { "disabled": true, "description": { "content": "border-width property of the HTML section", "type": "text/plain" }, "key": "borderWidth", "value": "" }, { "disabled": true, "description": { "content": "height property of the HTML section", "type": "text/plain" }, "key": "height", "value": "" }, { "disabled": true, "description": { "content": "Hide the section when displayed on a desktop browser. Default false", "type": "text/plain" }, "key": "hideDesktop", "value": "" }, { "disabled": true, "description": { "content": "Hide the section when displayed on a mobile browser. Default false", "type": "text/plain" }, "key": "hideMobile", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "imageOpenNewWindow", "value": "" }, { "disabled": true, "description": { "content": "Index of the content section. Determines the order of the section in the landing page", "type": "text/plain" }, "key": "index", "value": "" }, { "disabled": true, "description": { "content": "left property of the HTML section", "type": "text/plain" }, "key": "left", "value": "" }, { "disabled": true, "description": { "content": "URL parameter of a link type section", "type": "text/plain" }, "key": "linkUrl", "value": "" }, { "disabled": true, "description": { "content": "opacity property of the HTML section", "type": "text/plain" }, "key": "opacity", "value": "" }, { "disabled": true, "description": { "content": "top property of the HTML section", "type": "text/plain" }, "key": "top", "value": "" }, { "disabled": true, "description": { "content": "Type of content section", "type": "text/plain" }, "key": "value", "value": "" }, { "disabled": true, "description": { "content": "width property of the HTML section", "type": "text/plain" }, "key": "width", "value": "" }, { "disabled": true, "description": { "content": "z-index property of the HTML section", "type": "text/plain" }, "key": "zIndex", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ae954334-ccd2-406f-9376-b39c3edcd285", "name": "Delete Landing Page Content Section", "request": { "name": "Delete Landing Page Content Section", "description": { "content": "Removes the target content section from the parent landing page. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "landingPage", ":id", "content", ":contentId", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Id of landing page", "type": "text/plain" } }, { "type": "any", "value": "", "key": "contentId", "disabled": false, "description": { "content": "(Required) Id of landing page content section", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "2225fa76-0fc7-48a7-85f8-ee9eb3baac30", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "landingPage", ":id", "content", ":contentId", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of landing page", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Id of landing page content section", "type": "text/plain" }, "type": "any", "value": "", "key": "contentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fe7fba77-ca7a-44b2-9447-5cb4a40afb07", "name": "Get Landing Page Dynamic Content", "request": { "name": "Get Landing Page Dynamic Content", "description": { "content": "Retrieves the dynamic content from the target section. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "landingPage", ":id", "dynamicContent", "{{contentId}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Id of landing page", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "06e05b07-ae09-49f4-9d05-97f17924d2cc", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "landingPage", ":id", "dynamicContent", "{{contentId}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of landing page", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"content\": [\n {\n \"content\": {},\n \"segmentId\": \"\",\n \"segmentName\": \"\",\n \"type\": \"\",\n \"followupType\": \"\",\n \"followupValue\": \"\"\n },\n {\n \"content\": {},\n \"segmentId\": \"\",\n \"segmentName\": \"\",\n \"type\": \"\",\n \"followupType\": \"\",\n \"followupValue\": \"\"\n }\n ],\n \"createdAt\": \"\",\n \"id\": \"\",\n \"segmentation\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"content\": [\n {\n \"content\": {},\n \"segmentId\": \"\",\n \"segmentName\": \"\",\n \"type\": \"\",\n \"followupType\": \"\",\n \"followupValue\": \"\"\n },\n {\n \"content\": {},\n \"segmentId\": \"\",\n \"segmentName\": \"\",\n \"type\": \"\",\n \"followupType\": \"\",\n \"followupValue\": \"\"\n }\n ],\n \"createdAt\": \"\",\n \"id\": \"\",\n \"segmentation\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "436fb894-7cab-43af-952f-f86434ec658e", "name": "Update Landing Page Dynamic Content Section", "request": { "name": "Update Landing Page Dynamic Content Section", "description": { "content": "Updates the content of the target dynamic content section. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "landingPage", ":id", "dynamicContent", "{{contentId}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Id of the landing page", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "background-color property of the HTML section", "type": "text/plain" }, "key": "backgroundColor", "value": "" }, { "disabled": true, "description": { "content": "border-color property of the HTML section", "type": "text/plain" }, "key": "borderColor", "value": "" }, { "disabled": true, "description": { "content": "border-style property of the HTML section", "type": "text/plain" }, "key": "borderStyle", "value": "" }, { "disabled": true, "description": { "content": "border-width property of the HTML section", "type": "text/plain" }, "key": "borderWidth", "value": "" }, { "disabled": true, "description": { "content": "height property of the HTML section", "type": "text/plain" }, "key": "height", "value": "" }, { "disabled": true, "description": { "content": "Hide the section when displayed on a desktop browser. Default false", "type": "text/plain" }, "key": "hideDesktop", "value": "" }, { "disabled": true, "description": { "content": "Hide the section when displayed on a mobile browser. Default false", "type": "text/plain" }, "key": "hideMobile", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "imageOpenNewWindow", "value": "" }, { "disabled": true, "description": { "content": "left property of the HTML section", "type": "text/plain" }, "key": "left", "value": "" }, { "disabled": true, "description": { "content": "URL parameter of a link type section", "type": "text/plain" }, "key": "linkUrl", "value": "" }, { "disabled": true, "description": { "content": "opacity property of the HTML section", "type": "text/plain" }, "key": "opacity", "value": "" }, { "disabled": true, "description": { "content": "Name of the segment to display content section for", "type": "text/plain" }, "key": "segment", "value": "" }, { "disabled": true, "description": { "content": "top property of the HTML section", "type": "text/plain" }, "key": "top", "value": "" }, { "disabled": true, "description": { "content": "Type of content section", "type": "text/plain" }, "key": "type", "value": "" }, { "disabled": true, "description": { "content": "Type of content section", "type": "text/plain" }, "key": "value", "value": "" }, { "disabled": true, "description": { "content": "width property of the HTML section", "type": "text/plain" }, "key": "width", "value": "" }, { "disabled": true, "description": { "content": "z-index property of the HTML section", "type": "text/plain" }, "key": "zIndex", "value": "" } ] }, "auth": null }, "response": [ { "id": "97d4e955-bfa9-4eaa-bb64-108bb0f9c1e4", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "landingPage", ":id", "dynamicContent", "{{contentId}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the landing page", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "background-color property of the HTML section", "type": "text/plain" }, "key": "backgroundColor", "value": "" }, { "disabled": true, "description": { "content": "border-color property of the HTML section", "type": "text/plain" }, "key": "borderColor", "value": "" }, { "disabled": true, "description": { "content": "border-style property of the HTML section", "type": "text/plain" }, "key": "borderStyle", "value": "" }, { "disabled": true, "description": { "content": "border-width property of the HTML section", "type": "text/plain" }, "key": "borderWidth", "value": "" }, { "disabled": true, "description": { "content": "height property of the HTML section", "type": "text/plain" }, "key": "height", "value": "" }, { "disabled": true, "description": { "content": "Hide the section when displayed on a desktop browser. Default false", "type": "text/plain" }, "key": "hideDesktop", "value": "" }, { "disabled": true, "description": { "content": "Hide the section when displayed on a mobile browser. Default false", "type": "text/plain" }, "key": "hideMobile", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "imageOpenNewWindow", "value": "" }, { "disabled": true, "description": { "content": "left property of the HTML section", "type": "text/plain" }, "key": "left", "value": "" }, { "disabled": true, "description": { "content": "URL parameter of a link type section", "type": "text/plain" }, "key": "linkUrl", "value": "" }, { "disabled": true, "description": { "content": "opacity property of the HTML section", "type": "text/plain" }, "key": "opacity", "value": "" }, { "disabled": true, "description": { "content": "Name of the segment to display content section for", "type": "text/plain" }, "key": "segment", "value": "" }, { "disabled": true, "description": { "content": "top property of the HTML section", "type": "text/plain" }, "key": "top", "value": "" }, { "disabled": true, "description": { "content": "Type of content section", "type": "text/plain" }, "key": "type", "value": "" }, { "disabled": true, "description": { "content": "Type of content section", "type": "text/plain" }, "key": "value", "value": "" }, { "disabled": true, "description": { "content": "width property of the HTML section", "type": "text/plain" }, "key": "width", "value": "" }, { "disabled": true, "description": { "content": "z-index property of the HTML section", "type": "text/plain" }, "key": "zIndex", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Landing Page Templates", "description": "CRUD operations on landing page templates and their HTML content.", "item": [ { "id": "46179a20-83af-4d79-a07a-ec9f8fb33898", "name": "Get Landing Page Template by Name", "request": { "name": "Get Landing Page Template by Name", "description": { "content": "Retrieves the landing page template record for the given name. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "landingPageTemplate", "byName.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Name of the landing page template", "type": "text/plain" }, "key": "name", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "466f1bcb-1720-49df-84b7-80f231d3b7a1", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "landingPageTemplate", "byName.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Name of the landing page template", "type": "text/plain" }, "key": "name", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"enableMunchkin\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"status\": \"\",\n \"templateType\": \"freeForm\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n },\n {\n \"enableMunchkin\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"status\": \"\",\n \"templateType\": \"guided\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ac145237-df41-49bd-800a-494c3dd7907b", "name": "Get Landing Page Template by Id", "request": { "name": "Get Landing Page Template by Id", "description": { "content": "Retrieves the record for the target landing page template. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "landingPageTemplate", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d12061a7-e902-4523-a12b-7c26385d3665", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "landingPageTemplate", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"enableMunchkin\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"status\": \"\",\n \"templateType\": \"freeForm\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n },\n {\n \"enableMunchkin\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"status\": \"\",\n \"templateType\": \"guided\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f42db007-ca03-4f0e-a249-e524ff96e681", "name": "Update Landing Page Template Metadata", "request": { "name": "Update Landing Page Template Metadata", "description": { "content": "Updates the metadata for the target landing page template. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "landingPageTemplate", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "Description of the landing page template", "type": "text/plain" }, "key": "description", "value": "" }, { "disabled": true, "description": { "content": "Whether to enable munchkin on the derived pages. Defaults to true", "type": "text/plain" }, "key": "enableMunchkin", "value": "" }, { "disabled": true, "description": { "content": "Name of the landing page template", "type": "text/plain" }, "key": "name", "value": "" } ] }, "auth": null }, "response": [ { "id": "ce4aea3a-4ef5-4292-ada8-a1bd50d17eba", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "landingPageTemplate", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "Description of the landing page template", "type": "text/plain" }, "key": "description", "value": "" }, { "disabled": true, "description": { "content": "Whether to enable munchkin on the derived pages. Defaults to true", "type": "text/plain" }, "key": "enableMunchkin", "value": "" }, { "disabled": true, "description": { "content": "Name of the landing page template", "type": "text/plain" }, "key": "name", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"enableMunchkin\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"status\": \"\",\n \"templateType\": \"freeForm\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n },\n {\n \"enableMunchkin\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"status\": \"\",\n \"templateType\": \"guided\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ac5486d4-8b05-4111-ae67-c99d8c6fb54d", "name": "Approve Landing Page Template Draft", "request": { "name": "Approve Landing Page Template Draft", "description": { "content": "Approves the current landing page template draft. This will delete the current approved version of the template if there is one. Required Permissions: Approve Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "landingPageTemplate", ":id", "approveDraft.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "1b2edd78-77b2-4e3e-a553-a340dee41236", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "landingPageTemplate", ":id", "approveDraft.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"enableMunchkin\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"status\": \"\",\n \"templateType\": \"freeForm\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n },\n {\n \"enableMunchkin\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"status\": \"\",\n \"templateType\": \"guided\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3db9b1b6-3b75-4cc1-9261-cb897dbb6ebc", "name": "Clone Landing Page Template", "request": { "name": "Clone Landing Page Template", "description": { "content": "Clones the target landing page template. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "landingPageTemplate", ":id", "clone.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "type", "value": "Folder" }, { "disabled": false, "description": { "content": "(Required) Name of the landing page template", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Description of the landing page template", "type": "text/plain" }, "key": "description", "value": "" } ] }, "auth": null }, "response": [ { "id": "9e9e84bc-23c0-4498-a74a-5817befb865f", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "landingPageTemplate", ":id", "clone.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "type", "value": "Folder" }, { "disabled": false, "description": { "content": "(Required) Name of the landing page template", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Description of the landing page template", "type": "text/plain" }, "key": "description", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"enableMunchkin\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"status\": \"\",\n \"templateType\": \"freeForm\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n },\n {\n \"enableMunchkin\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"status\": \"\",\n \"templateType\": \"guided\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0d4c428b-cc51-4c21-a6cd-4708e03cfbc8", "name": "Get Landing Page Template Content", "request": { "name": "Get Landing Page Template Content", "description": { "content": "Retrieves the content of the target landing page. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "landingPageTemplate", ":id", "content.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "7d2eac8e-10a3-489a-b499-d42bdb0e3969", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "landingPageTemplate", ":id", "content.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"content\": \"\",\n \"enableMunchkin\": \"\",\n \"id\": \"\",\n \"status\": \"draft\",\n \"templateType\": \"freeForm\"\n },\n {\n \"content\": \"\",\n \"enableMunchkin\": \"\",\n \"id\": \"\",\n \"status\": \"approved\",\n \"templateType\": \"freeForm\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eca52dc3-8710-4ea6-b06a-080d4b8818fe", "name": "Update Landing Page Template Content", "request": { "name": "Update Landing Page Template Content", "description": { "content": "Updates the content for the target landing page template. This update is destructive for the draft version of the template. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "landingPageTemplate", ":id", "content.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) content", "type": "text/plain" }, "key": "content", "value": "", "type": "text" } ] }, "auth": null }, "response": [ { "id": "d08b7c74-9b02-4552-b420-453d66ee2fd7", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "landingPageTemplate", ":id", "content.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) content", "type": "text/plain" }, "key": "content", "value": "", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1cac4b60-c841-4bb0-843c-c9aea89b91cf", "name": "Delete Landing Page Template", "request": { "name": "Delete Landing Page Template", "description": { "content": "Deletes the target landing page template. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "landingPageTemplate", ":id", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "de043c08-67d7-4a5d-bd1d-2f090d09421a", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "landingPageTemplate", ":id", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e540b7ec-86b8-4bc6-a60a-5f3a909fc465", "name": "Discard Landing Page Template Draft", "request": { "name": "Discard Landing Page Template Draft", "description": { "content": "Discrads the current draft of the landing page template. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "landingPageTemplate", ":id", "discardDraft.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "3b5a30be-a03c-4ff0-bc17-e29139b63f0f", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "landingPageTemplate", ":id", "discardDraft.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e2fd5253-6abe-4c1e-ab75-8943f079ce8c", "name": "Unapprove Landing Page Template", "request": { "name": "Unapprove Landing Page Template", "description": { "content": "Unapproves the landing page template and reverts it to a draft-only state. Required Permissions: Approve Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "landingPageTemplate", ":id", "unapprove.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "596fb36d-8e52-4ae5-83d1-cfe5e4fdf1fb", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "landingPageTemplate", ":id", "unapprove.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"enableMunchkin\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"status\": \"\",\n \"templateType\": \"freeForm\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n },\n {\n \"enableMunchkin\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"status\": \"\",\n \"templateType\": \"guided\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e06e63d0-17ee-482b-8eb1-eceab96b583a", "name": "Get Landing Page Templates", "request": { "name": "Get Landing Page Templates", "description": { "content": "Retrieves the list of accessible landing page templates from the target instance. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "landingPageTemplates.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of records to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" }, { "disabled": true, "description": { "content": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "folder", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4a308395-b164-437a-ad6d-48d84ba8668e", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "landingPageTemplates.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of records to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" }, { "disabled": true, "description": { "content": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "folder", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"enableMunchkin\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"status\": \"\",\n \"templateType\": \"freeForm\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n },\n {\n \"enableMunchkin\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"status\": \"\",\n \"templateType\": \"guided\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "70b2cbfa-19df-4c7a-8cc9-b768118a97ad", "name": "Create Landing Page Template", "request": { "name": "Create Landing Page Template", "description": { "content": "Creates a new landing page template. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "landingPageTemplates.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "type", "value": "Folder" }, { "disabled": false, "description": { "content": "(Required) Name of the landing page template", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Description of the landing page template", "type": "text/plain" }, "key": "description", "value": "" }, { "disabled": true, "description": { "content": "Whether to enable munchkin on the derived pages. Defaults to true", "type": "text/plain" }, "key": "enableMunchkin", "value": "" }, { "disabled": true, "description": { "content": "Type of template to create. Defaults to freeForm", "type": "text/plain" }, "key": "templateType", "value": "freeForm" } ] }, "auth": null }, "response": [ { "id": "85e9b037-6663-4339-87fb-2d3a6280dd1d", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "landingPageTemplates.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "type", "value": "Folder" }, { "disabled": false, "description": { "content": "(Required) Name of the landing page template", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Description of the landing page template", "type": "text/plain" }, "key": "description", "value": "" }, { "disabled": true, "description": { "content": "Whether to enable munchkin on the derived pages. Defaults to true", "type": "text/plain" }, "key": "enableMunchkin", "value": "" }, { "disabled": true, "description": { "content": "Type of template to create. Defaults to freeForm", "type": "text/plain" }, "key": "templateType", "value": "freeForm" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"enableMunchkin\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"status\": \"\",\n \"templateType\": \"freeForm\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n },\n {\n \"enableMunchkin\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"status\": \"\",\n \"templateType\": \"guided\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Landing Page Redirect Rules", "description": "Manage redirect rules that map old landing page URLs to new destinations.", "item": [ { "id": "b1b5889d-385f-4fb0-9d19-11dfa874da49", "name": "Get Landing Page Domains", "request": { "name": "Get Landing Page Domains", "description": { "content": "Retrieves a list of landing page domain and domain aliases. Required Permissions: Read Only Redirect Rules, Read Write Redirect Rules", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "landingPageDomains.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of landing page domains and domain aliases to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d384ee97-f90a-4e19-881f-3eee98bd8b07", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "landingPageDomains.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of landing page domains and domain aliases to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"hostname\": \"\",\n \"type\": \"domain\"\n },\n {\n \"hostname\": \"\",\n \"type\": \"domain-alias\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7bebe6f7-94dc-431d-8695-3e5a1d8c23ee", "name": "Get Landing Page Redirect Rule by Id", "request": { "name": "Get Landing Page Redirect Rule by Id", "description": { "content": "Retrieves the landing page redirect rule record. Required Permissions: Read Only Redirect Rules, Read Write Redirect Rules", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "redirectRule", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "50790da5-a972-41bc-913c-e8e17f448833", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "redirectRule", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"redirectFromUrl\": \"\",\n \"redirectToUrl\": \"\",\n \"hostname\": \"\",\n \"redirectFrom\": {\n \"type\": \"path\",\n \"value\": \"\"\n },\n \"redirectTo\": {\n \"type\": \"url\",\n \"value\": \"\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"redirectFromUrl\": \"\",\n \"redirectToUrl\": \"\",\n \"hostname\": \"\",\n \"redirectFrom\": {\n \"type\": \"path\",\n \"value\": \"\"\n },\n \"redirectTo\": {\n \"type\": \"url\",\n \"value\": \"\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "38195f05-5f31-4c9c-bdfe-872a05e881fd", "name": "Update Landing Page Redirect Rule", "request": { "name": "Update Landing Page Redirect Rule", "description": { "content": "Update an existing landing page redirect rule. Required Permissions: Read Write Redirect Rules", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "redirectRule", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "The hostname for the landing pages. Branding domain or alias. Max 255 characters", "type": "text/plain" }, "key": "hostname", "value": "" }, { "disabled": true, "description": { "content": "JSON representation of redirect from landing page, with members 'type' which may be 'landingPageId' or 'path', and 'value'", "type": "text/plain" }, "key": "type", "value": "landingPageId" }, { "disabled": true, "description": { "content": "JSON representation of redirect from landing page, with members 'type' which may be 'landingPageId' or 'path', and 'value'", "type": "text/plain" }, "key": "value", "value": "" }, { "disabled": true, "description": { "content": "JSON representation of redirect to landing page, with members 'type' which may be 'landingPageId' or 'url', and 'value'", "type": "text/plain" }, "key": "type", "value": "url" }, { "disabled": true, "description": { "content": "JSON representation of redirect to landing page, with members 'type' which may be 'landingPageId' or 'url', and 'value'", "type": "text/plain" }, "key": "value", "value": "" } ] }, "auth": null }, "response": [ { "id": "38aa469a-99b0-43ab-8f76-f6d45cd161de", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "redirectRule", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "The hostname for the landing pages. Branding domain or alias. Max 255 characters", "type": "text/plain" }, "key": "hostname", "value": "" }, { "disabled": true, "description": { "content": "JSON representation of redirect from landing page, with members 'type' which may be 'landingPageId' or 'path', and 'value'", "type": "text/plain" }, "key": "type", "value": "landingPageId" }, { "disabled": true, "description": { "content": "JSON representation of redirect from landing page, with members 'type' which may be 'landingPageId' or 'path', and 'value'", "type": "text/plain" }, "key": "value", "value": "" }, { "disabled": true, "description": { "content": "JSON representation of redirect to landing page, with members 'type' which may be 'landingPageId' or 'url', and 'value'", "type": "text/plain" }, "key": "type", "value": "url" }, { "disabled": true, "description": { "content": "JSON representation of redirect to landing page, with members 'type' which may be 'landingPageId' or 'url', and 'value'", "type": "text/plain" }, "key": "value", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"redirectFromUrl\": \"\",\n \"redirectToUrl\": \"\",\n \"hostname\": \"\",\n \"redirectFrom\": {\n \"type\": \"path\",\n \"value\": \"\"\n },\n \"redirectTo\": {\n \"type\": \"url\",\n \"value\": \"\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"redirectFromUrl\": \"\",\n \"redirectToUrl\": \"\",\n \"hostname\": \"\",\n \"redirectFrom\": {\n \"type\": \"path\",\n \"value\": \"\"\n },\n \"redirectTo\": {\n \"type\": \"url\",\n \"value\": \"\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7d7531dd-2ec0-4d99-b680-bd51bcf3363a", "name": "Delete Landing Page Redirect Rule", "request": { "name": "Delete Landing Page Redirect Rule", "description": { "content": "Delete a landing page redirect rule. Required Permissions: Read Write Redirect Rules", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "redirectRule", ":id", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Id of landing page redirect rule", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "e90127d3-1fc2-4450-9688-239d6e17de93", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "redirectRule", ":id", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of landing page redirect rule", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fc736bdb-f971-4da3-a1e7-43044787e9bd", "name": "Get Landing Page Redirect Rules", "request": { "name": "Get Landing Page Redirect Rules", "description": { "content": "Retrieves a list of landing page redirect rules from the target instance. Required Permissions: Read Only Redirect Rules, Read Write Redirect Rules", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "redirectRules.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of landing page redirect rules to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Landing page id of landing page to redirect to", "type": "text/plain" }, "key": "redirectTolandingPageId", "value": "" }, { "disabled": true, "description": { "content": "Path of landing page to redirect to", "type": "text/plain" }, "key": "redirectToPath", "value": "" }, { "disabled": true, "description": { "content": "Exclude landing page redirect rules prior to this date. Must be valid ISO-8601 string. See Datetime field type description.", "type": "text/plain" }, "key": "earliestUpdatedAt", "value": "" }, { "disabled": true, "description": { "content": "Exclude landing page redirect rules after this date. Must be valid ISO-8601 string. See Datetime field type description.", "type": "text/plain" }, "key": "latestUpdatedAt", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0cf9ea6d-9124-4a33-bbe8-de8a2403084b", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "redirectRules.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of landing page redirect rules to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Landing page id of landing page to redirect to", "type": "text/plain" }, "key": "redirectTolandingPageId", "value": "" }, { "disabled": true, "description": { "content": "Path of landing page to redirect to", "type": "text/plain" }, "key": "redirectToPath", "value": "" }, { "disabled": true, "description": { "content": "Exclude landing page redirect rules prior to this date. Must be valid ISO-8601 string. See Datetime field type description.", "type": "text/plain" }, "key": "earliestUpdatedAt", "value": "" }, { "disabled": true, "description": { "content": "Exclude landing page redirect rules after this date. Must be valid ISO-8601 string. See Datetime field type description.", "type": "text/plain" }, "key": "latestUpdatedAt", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"redirectFromUrl\": \"\",\n \"redirectToUrl\": \"\",\n \"hostname\": \"\",\n \"redirectFrom\": {\n \"type\": \"path\",\n \"value\": \"\"\n },\n \"redirectTo\": {\n \"type\": \"url\",\n \"value\": \"\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"redirectFromUrl\": \"\",\n \"redirectToUrl\": \"\",\n \"hostname\": \"\",\n \"redirectFrom\": {\n \"type\": \"path\",\n \"value\": \"\"\n },\n \"redirectTo\": {\n \"type\": \"url\",\n \"value\": \"\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ab8fc22a-2d59-4a91-9bee-7ccbaf19f975", "name": "Create Landing Page Redirect Rule", "request": { "name": "Create Landing Page Redirect Rule", "description": { "content": "Create a new landing page redirect rule. Required Permissions: Read Write Redirect Rules", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "redirectRules.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) The hostname for the landing pages. Branding domain or alias. Max 255 characters", "type": "text/plain" }, "key": "hostname", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of redirect from landing page, with members 'type' which may be 'landingPageId' or 'path', and 'value'", "type": "text/plain" }, "key": "type", "value": "landingPageId" }, { "disabled": false, "description": { "content": "(Required) JSON representation of redirect from landing page, with members 'type' which may be 'landingPageId' or 'path', and 'value'", "type": "text/plain" }, "key": "value", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of redirect to landing page, with members 'type' which may be 'landingPageId' or 'url', and 'value'", "type": "text/plain" }, "key": "type", "value": "url" }, { "disabled": false, "description": { "content": "(Required) JSON representation of redirect to landing page, with members 'type' which may be 'landingPageId' or 'url', and 'value'", "type": "text/plain" }, "key": "value", "value": "" } ] }, "auth": null }, "response": [ { "id": "17776b9e-4809-4027-8aff-f19986059c61", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "redirectRules.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) The hostname for the landing pages. Branding domain or alias. Max 255 characters", "type": "text/plain" }, "key": "hostname", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of redirect from landing page, with members 'type' which may be 'landingPageId' or 'path', and 'value'", "type": "text/plain" }, "key": "type", "value": "landingPageId" }, { "disabled": false, "description": { "content": "(Required) JSON representation of redirect from landing page, with members 'type' which may be 'landingPageId' or 'path', and 'value'", "type": "text/plain" }, "key": "value", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of redirect to landing page, with members 'type' which may be 'landingPageId' or 'url', and 'value'", "type": "text/plain" }, "key": "type", "value": "url" }, { "disabled": false, "description": { "content": "(Required) JSON representation of redirect to landing page, with members 'type' which may be 'landingPageId' or 'url', and 'value'", "type": "text/plain" }, "key": "value", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"redirectFromUrl\": \"\",\n \"redirectToUrl\": \"\",\n \"hostname\": \"\",\n \"redirectFrom\": {\n \"type\": \"path\",\n \"value\": \"\"\n },\n \"redirectTo\": {\n \"type\": \"url\",\n \"value\": \"\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"redirectFromUrl\": \"\",\n \"redirectToUrl\": \"\",\n \"hostname\": \"\",\n \"redirectFrom\": {\n \"type\": \"path\",\n \"value\": \"\"\n },\n \"redirectTo\": {\n \"type\": \"url\",\n \"value\": \"\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Forms", "description": "CRUD operations on forms, including approval, cloning, and submit-button and thank-you-page settings.", "item": [ { "id": "1bdab979-3407-42c2-9fdc-4976de89f1cc", "name": "Get Form by Name", "request": { "name": "Get Form by Name", "description": { "content": "Retrieves a form record by its name. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "form", "byName.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Name of the form", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" }, { "disabled": true, "description": { "content": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "folder", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f3357c0b-02c2-4c80-bdb8-4656544e1428", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "form", "byName.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Name of the form", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" }, { "disabled": true, "description": { "content": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "folder", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"buttonLabel\": \"\",\n \"buttonLocation\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"fontFamily\": \"\",\n \"fontSize\": \"\",\n \"knownVisitor\": {\n \"template\": \"\",\n \"type\": \"\"\n },\n \"labelPosition\": \"\",\n \"language\": \"\",\n \"locale\": \"\",\n \"progressiveProfiling\": \"\",\n \"status\": \"approved\",\n \"thankYouList\": [\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"theme\": \"\",\n \"waitingLabel\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\"\n },\n {\n \"buttonLabel\": \"\",\n \"buttonLocation\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"fontFamily\": \"\",\n \"fontSize\": \"\",\n \"knownVisitor\": {\n \"template\": \"\",\n \"type\": \"\"\n },\n \"labelPosition\": \"\",\n \"language\": \"\",\n \"locale\": \"\",\n \"progressiveProfiling\": \"\",\n \"status\": \"approved\",\n \"thankYouList\": [\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"theme\": \"\",\n \"waitingLabel\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2908cd50-f880-4307-bdd7-113307c275aa", "name": "Get Form By Id", "request": { "name": "Get Form By Id", "description": { "content": "Retrieves a form record by its id. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "form", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4d45ef10-c00e-4ae9-bbad-ff461dd337b8", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "form", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"buttonLabel\": \"\",\n \"buttonLocation\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"fontFamily\": \"\",\n \"fontSize\": \"\",\n \"knownVisitor\": {\n \"template\": \"\",\n \"type\": \"\"\n },\n \"labelPosition\": \"\",\n \"language\": \"\",\n \"locale\": \"\",\n \"progressiveProfiling\": \"\",\n \"status\": \"approved\",\n \"thankYouList\": [\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"theme\": \"\",\n \"waitingLabel\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\"\n },\n {\n \"buttonLabel\": \"\",\n \"buttonLocation\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"fontFamily\": \"\",\n \"fontSize\": \"\",\n \"knownVisitor\": {\n \"template\": \"\",\n \"type\": \"\"\n },\n \"labelPosition\": \"\",\n \"language\": \"\",\n \"locale\": \"\",\n \"progressiveProfiling\": \"\",\n \"status\": \"approved\",\n \"thankYouList\": [\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"theme\": \"\",\n \"waitingLabel\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a2d83850-08ef-4ff4-a7ee-d4f4ff52a11f", "name": "Update Form Metadata", "request": { "name": "Update Form Metadata", "description": { "content": "Updates the metadata of the target form. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "form", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "Custom CSS to apply to the form", "type": "text/plain" }, "key": "customCss", "value": "" }, { "disabled": true, "description": { "content": "Description of the form", "type": "text/plain" }, "key": "description", "value": "" }, { "disabled": true, "description": { "content": "font-family property for the form", "type": "text/plain" }, "key": "fontFamily", "value": "" }, { "disabled": true, "description": { "content": "font-size property of the form", "type": "text/plain" }, "key": "fontSize", "value": "" }, { "disabled": true, "description": { "content": "Known visitor behavior for the form", "type": "text/plain" }, "key": "template", "value": "" }, { "disabled": true, "description": { "content": "Known visitor behavior for the form", "type": "text/plain" }, "key": "type", "value": "" }, { "disabled": true, "description": { "content": "Default positioning of labels.", "type": "text/plain" }, "key": "labelPosition", "value": "" }, { "disabled": true, "description": { "content": "Language of the form", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": true, "description": { "content": "Locale of the form", "type": "text/plain" }, "key": "locale", "value": "" }, { "disabled": true, "description": { "content": "Name of the form", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Whether progressive profiling is enabled for the form", "type": "text/plain" }, "key": "progressiveProfiling", "value": "" }, { "disabled": true, "description": { "content": "CSS theme for the form to use", "type": "text/plain" }, "key": "theme", "value": "" } ] }, "auth": null }, "response": [ { "id": "04e81eca-41bc-40e5-b362-05446c978e0c", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "form", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "Custom CSS to apply to the form", "type": "text/plain" }, "key": "customCss", "value": "" }, { "disabled": true, "description": { "content": "Description of the form", "type": "text/plain" }, "key": "description", "value": "" }, { "disabled": true, "description": { "content": "font-family property for the form", "type": "text/plain" }, "key": "fontFamily", "value": "" }, { "disabled": true, "description": { "content": "font-size property of the form", "type": "text/plain" }, "key": "fontSize", "value": "" }, { "disabled": true, "description": { "content": "Known visitor behavior for the form", "type": "text/plain" }, "key": "template", "value": "" }, { "disabled": true, "description": { "content": "Known visitor behavior for the form", "type": "text/plain" }, "key": "type", "value": "" }, { "disabled": true, "description": { "content": "Default positioning of labels.", "type": "text/plain" }, "key": "labelPosition", "value": "" }, { "disabled": true, "description": { "content": "Language of the form", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": true, "description": { "content": "Locale of the form", "type": "text/plain" }, "key": "locale", "value": "" }, { "disabled": true, "description": { "content": "Name of the form", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Whether progressive profiling is enabled for the form", "type": "text/plain" }, "key": "progressiveProfiling", "value": "" }, { "disabled": true, "description": { "content": "CSS theme for the form to use", "type": "text/plain" }, "key": "theme", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"buttonLabel\": \"\",\n \"buttonLocation\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"fontFamily\": \"\",\n \"fontSize\": \"\",\n \"knownVisitor\": {\n \"template\": \"\",\n \"type\": \"\"\n },\n \"labelPosition\": \"\",\n \"language\": \"\",\n \"locale\": \"\",\n \"progressiveProfiling\": \"\",\n \"status\": \"approved\",\n \"thankYouList\": [\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"theme\": \"\",\n \"waitingLabel\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\"\n },\n {\n \"buttonLabel\": \"\",\n \"buttonLocation\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"fontFamily\": \"\",\n \"fontSize\": \"\",\n \"knownVisitor\": {\n \"template\": \"\",\n \"type\": \"\"\n },\n \"labelPosition\": \"\",\n \"language\": \"\",\n \"locale\": \"\",\n \"progressiveProfiling\": \"\",\n \"status\": \"approved\",\n \"thankYouList\": [\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"theme\": \"\",\n \"waitingLabel\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9e21a59a-0084-4dc5-be65-3c365a9dd8fd", "name": "Approve Form Draft", "request": { "name": "Approve Form Draft", "description": { "content": "Approves the current draft of the form. This will delete the current approved version of the form. Required Permissions: Approve Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "form", ":id", "approveDraft.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "807a9742-2968-4e58-9576-8342ef347fde", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "form", ":id", "approveDraft.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"buttonLabel\": \"\",\n \"buttonLocation\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"fontFamily\": \"\",\n \"fontSize\": \"\",\n \"knownVisitor\": {\n \"template\": \"\",\n \"type\": \"\"\n },\n \"labelPosition\": \"\",\n \"language\": \"\",\n \"locale\": \"\",\n \"progressiveProfiling\": \"\",\n \"status\": \"approved\",\n \"thankYouList\": [\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"theme\": \"\",\n \"waitingLabel\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\"\n },\n {\n \"buttonLabel\": \"\",\n \"buttonLocation\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"fontFamily\": \"\",\n \"fontSize\": \"\",\n \"knownVisitor\": {\n \"template\": \"\",\n \"type\": \"\"\n },\n \"labelPosition\": \"\",\n \"language\": \"\",\n \"locale\": \"\",\n \"progressiveProfiling\": \"\",\n \"status\": \"approved\",\n \"thankYouList\": [\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"theme\": \"\",\n \"waitingLabel\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "254836ce-6308-447f-8584-4a38031a15f0", "name": "Clone Form", "request": { "name": "Clone Form", "description": { "content": "Clones the target form. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "form", ":id", "clone.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Name for the cloned form", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "type", "value": "Program" }, { "disabled": true, "description": { "content": "Description of the cloned form", "type": "text/plain" }, "key": "description", "value": "" } ] }, "auth": null }, "response": [ { "id": "ba5dcc71-37c9-4e61-87a8-4d7a40037c95", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "form", ":id", "clone.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Name for the cloned form", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "type", "value": "Program" }, { "disabled": true, "description": { "content": "Description of the cloned form", "type": "text/plain" }, "key": "description", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"buttonLabel\": \"\",\n \"buttonLocation\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"fontFamily\": \"\",\n \"fontSize\": \"\",\n \"knownVisitor\": {\n \"template\": \"\",\n \"type\": \"\"\n },\n \"labelPosition\": \"\",\n \"language\": \"\",\n \"locale\": \"\",\n \"progressiveProfiling\": \"\",\n \"status\": \"approved\",\n \"thankYouList\": [\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"theme\": \"\",\n \"waitingLabel\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\"\n },\n {\n \"buttonLabel\": \"\",\n \"buttonLocation\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"fontFamily\": \"\",\n \"fontSize\": \"\",\n \"knownVisitor\": {\n \"template\": \"\",\n \"type\": \"\"\n },\n \"labelPosition\": \"\",\n \"language\": \"\",\n \"locale\": \"\",\n \"progressiveProfiling\": \"\",\n \"status\": \"approved\",\n \"thankYouList\": [\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"theme\": \"\",\n \"waitingLabel\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0f4006de-1d36-4df9-9748-809043bc0eaf", "name": "Delete Form", "request": { "name": "Delete Form", "description": { "content": "Deletes the target form. Forms which are in use by landing pages may not be deleted until they are removed from all landing pages. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "form", ":id", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "675af5a7-e2bb-40cf-8ec3-76dd2c4e0537", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "form", ":id", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f5ca8e5f-ccb2-4a90-a18a-dfda00522d26", "name": "Discard Form Draft", "request": { "name": "Discard Form Draft", "description": { "content": "Discards the current draft of the form. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "form", ":id", "discardDraft.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "5559525a-26b0-4918-b161-d36e69fb5ae9", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "form", ":id", "discardDraft.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fc039700-d60b-4296-aef4-884ec191aca2", "name": "Update Submit Button", "request": { "name": "Update Submit Button", "description": { "content": "Updates the submit button configuration for the target form. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "form", ":id", "submitButton.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "Location in pixels of the button relative to the left of the form", "type": "text/plain" }, "key": "buttonPosition", "value": "" }, { "disabled": true, "description": { "content": "Style of the button", "type": "text/plain" }, "key": "buttonStyle", "value": "" }, { "disabled": true, "description": { "content": "Label text of the button", "type": "text/plain" }, "key": "label", "value": "" }, { "disabled": true, "description": { "content": "Waiting text of the button", "type": "text/plain" }, "key": "waitingLabel", "value": "" } ] }, "auth": null }, "response": [ { "id": "81ca870e-27e1-4037-9426-50d8898530d5", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "form", ":id", "submitButton.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "Location in pixels of the button relative to the left of the form", "type": "text/plain" }, "key": "buttonPosition", "value": "" }, { "disabled": true, "description": { "content": "Style of the button", "type": "text/plain" }, "key": "buttonStyle", "value": "" }, { "disabled": true, "description": { "content": "Label text of the button", "type": "text/plain" }, "key": "label", "value": "" }, { "disabled": true, "description": { "content": "Waiting text of the button", "type": "text/plain" }, "key": "waitingLabel", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"buttonLabel\": \"\",\n \"buttonLocation\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"fontFamily\": \"\",\n \"fontSize\": \"\",\n \"knownVisitor\": {\n \"template\": \"\",\n \"type\": \"\"\n },\n \"labelPosition\": \"\",\n \"language\": \"\",\n \"locale\": \"\",\n \"progressiveProfiling\": \"\",\n \"status\": \"approved\",\n \"thankYouList\": [\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"theme\": \"\",\n \"waitingLabel\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\"\n },\n {\n \"buttonLabel\": \"\",\n \"buttonLocation\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"fontFamily\": \"\",\n \"fontSize\": \"\",\n \"knownVisitor\": {\n \"template\": \"\",\n \"type\": \"\"\n },\n \"labelPosition\": \"\",\n \"language\": \"\",\n \"locale\": \"\",\n \"progressiveProfiling\": \"\",\n \"status\": \"approved\",\n \"thankYouList\": [\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"theme\": \"\",\n \"waitingLabel\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e7703516-8e43-4b11-bc74-a1b0aec1fa62", "name": "Get Thank You Page by Form Id", "request": { "name": "Get Thank You Page by Form Id", "description": { "content": "Returns the thank you page configuration for a given form. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "form", ":id", "thankYouPage.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f8679dce-4a01-4620-aadd-4d109d661115", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "form", ":id", "thankYouPage.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"thankYouList\": [\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\n \"id\": \"\",\n \"thankYouList\": [\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c3f9a901-ca92-4cbe-b2ee-78edbcb955a1", "name": "Update Thank You Page", "request": { "name": "Update Thank You Page", "description": { "content": "Updates the thank you page configuration for a given form. This update is destructive and the resulting draft will not have any memory of the previous configuration. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "form", ":id", "thankYouPage.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "JSON array of followup rules", "type": "text/plain" }, "key": "thankyou", "value": "[object Object]" }, { "disabled": true, "description": { "content": "JSON array of followup rules", "type": "text/plain" }, "key": "thankyou", "value": "[object Object]" } ] }, "auth": null }, "response": [ { "id": "1f3916ae-3ae1-4b11-9233-6f9d7d849df5", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "form", ":id", "thankYouPage.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "JSON array of followup rules", "type": "text/plain" }, "key": "thankyou", "value": "[object Object]" }, { "disabled": true, "description": { "content": "JSON array of followup rules", "type": "text/plain" }, "key": "thankyou", "value": "[object Object]" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"thankYouList\": [\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\n \"id\": \"\",\n \"thankYouList\": [\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c8940c6c-1ebf-4f17-84ab-daf063ee3472", "name": "Get Form Used By", "request": { "name": "Get Form Used By", "description": { "content": "Returns a list of asset records which depend on a given form. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "form", ":id", "usedBy.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of assets to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Id of the form", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a8754635-f8f2-49de-b725-162d553ca1d8", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "form", ":id", "usedBy.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of assets to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the form", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"status\": \"draft\",\n \"updatedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"status\": \"approved\",\n \"updatedAt\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "25d69ad0-1186-4bf0-b0cd-5ad58a81ddc0", "name": "Get Forms", "request": { "name": "Get Forms", "description": { "content": "Retrieves a list of accessible form records from the target instance. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "forms.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" }, { "disabled": true, "description": { "content": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "folder", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of forms to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e6b2ed7b-0c42-4e0e-923a-c117f9fb4198", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "forms.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" }, { "disabled": true, "description": { "content": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "folder", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of forms to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"buttonLabel\": \"\",\n \"buttonLocation\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"fontFamily\": \"\",\n \"fontSize\": \"\",\n \"knownVisitor\": {\n \"template\": \"\",\n \"type\": \"\"\n },\n \"labelPosition\": \"\",\n \"language\": \"\",\n \"locale\": \"\",\n \"progressiveProfiling\": \"\",\n \"status\": \"approved\",\n \"thankYouList\": [\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"theme\": \"\",\n \"waitingLabel\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\"\n },\n {\n \"buttonLabel\": \"\",\n \"buttonLocation\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"fontFamily\": \"\",\n \"fontSize\": \"\",\n \"knownVisitor\": {\n \"template\": \"\",\n \"type\": \"\"\n },\n \"labelPosition\": \"\",\n \"language\": \"\",\n \"locale\": \"\",\n \"progressiveProfiling\": \"\",\n \"status\": \"approved\",\n \"thankYouList\": [\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"theme\": \"\",\n \"waitingLabel\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6a514444-0642-499b-8ed5-5e8a87a02507", "name": "Create Form", "request": { "name": "Create Form", "description": { "content": "Creates a new form. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "forms.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "type", "value": "Folder" }, { "disabled": true, "description": { "content": "Description of the form", "type": "text/plain" }, "key": "description", "value": "" }, { "disabled": true, "description": { "content": "font-family property for the form", "type": "text/plain" }, "key": "fontFamily", "value": "" }, { "disabled": true, "description": { "content": "font-size property of the form", "type": "text/plain" }, "key": "fontSize", "value": "" }, { "disabled": true, "description": { "content": "Known visitor behavior for the form", "type": "text/plain" }, "key": "template", "value": "" }, { "disabled": true, "description": { "content": "Known visitor behavior for the form", "type": "text/plain" }, "key": "type", "value": "" }, { "disabled": true, "description": { "content": "Default positioning of labels.", "type": "text/plain" }, "key": "labelPosition", "value": "" }, { "disabled": true, "description": { "content": "Language of the form", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": true, "description": { "content": "Locale of the form", "type": "text/plain" }, "key": "locale", "value": "" }, { "disabled": true, "description": { "content": "Name of the form", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Whether progressive profiling is enabled for the form", "type": "text/plain" }, "key": "progressiveProfiling", "value": "" }, { "disabled": true, "description": { "content": "CSS theme for the form to use", "type": "text/plain" }, "key": "theme", "value": "" } ] }, "auth": null }, "response": [ { "id": "e7fa9a2a-4051-4d6c-b58a-5d2862cfb3f4", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "forms.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "type", "value": "Folder" }, { "disabled": true, "description": { "content": "Description of the form", "type": "text/plain" }, "key": "description", "value": "" }, { "disabled": true, "description": { "content": "font-family property for the form", "type": "text/plain" }, "key": "fontFamily", "value": "" }, { "disabled": true, "description": { "content": "font-size property of the form", "type": "text/plain" }, "key": "fontSize", "value": "" }, { "disabled": true, "description": { "content": "Known visitor behavior for the form", "type": "text/plain" }, "key": "template", "value": "" }, { "disabled": true, "description": { "content": "Known visitor behavior for the form", "type": "text/plain" }, "key": "type", "value": "" }, { "disabled": true, "description": { "content": "Default positioning of labels.", "type": "text/plain" }, "key": "labelPosition", "value": "" }, { "disabled": true, "description": { "content": "Language of the form", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": true, "description": { "content": "Locale of the form", "type": "text/plain" }, "key": "locale", "value": "" }, { "disabled": true, "description": { "content": "Name of the form", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Whether progressive profiling is enabled for the form", "type": "text/plain" }, "key": "progressiveProfiling", "value": "" }, { "disabled": true, "description": { "content": "CSS theme for the form to use", "type": "text/plain" }, "key": "theme", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"buttonLabel\": \"\",\n \"buttonLocation\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"fontFamily\": \"\",\n \"fontSize\": \"\",\n \"knownVisitor\": {\n \"template\": \"\",\n \"type\": \"\"\n },\n \"labelPosition\": \"\",\n \"language\": \"\",\n \"locale\": \"\",\n \"progressiveProfiling\": \"\",\n \"status\": \"approved\",\n \"thankYouList\": [\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"theme\": \"\",\n \"waitingLabel\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\"\n },\n {\n \"buttonLabel\": \"\",\n \"buttonLocation\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"fontFamily\": \"\",\n \"fontSize\": \"\",\n \"knownVisitor\": {\n \"template\": \"\",\n \"type\": \"\"\n },\n \"labelPosition\": \"\",\n \"language\": \"\",\n \"locale\": \"\",\n \"progressiveProfiling\": \"\",\n \"status\": \"approved\",\n \"thankYouList\": [\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"default\": \"\",\n \"followupType\": \"\",\n \"followupValue\": {},\n \"operator\": \"\",\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"theme\": \"\",\n \"waitingLabel\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Form Fields", "description": "Manage the fields on a form, their ordering, visibility rules, and validation.", "item": [ { "id": "97d02be3-6a62-43fd-9e61-d4cc34edf56f", "name": "Get Available Form Fields", "request": { "name": "Get Available Form Fields", "description": { "content": "Retrieves a list of all valid fields for use in forms. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "form", "fields.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of fields to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "314db700-c91c-4c62-996c-36610a395f5e", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "form", "fields.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of fields to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"dataType\": \"\",\n \"defaultValue\": \"\",\n \"description\": \"\",\n \"fieldMaskValues\": \"\",\n \"fieldWidth\": \"\",\n \"initiallyChecked\": \"\",\n \"isLabelToRight\": \"\",\n \"isMultiselect\": \"\",\n \"isRequired\": \"\",\n \"isSensitive\": \"\",\n \"labelWidth\": \"\",\n \"maxLength\": \"\",\n \"maximumNumber\": \"\",\n \"minimumNumber\": \"\",\n \"picklistValues\": \"\",\n \"placeholderText\": \"\",\n \"validationMessage\": \"\",\n \"visibleRows\": \"\"\n },\n {\n \"id\": \"\",\n \"dataType\": \"\",\n \"defaultValue\": \"\",\n \"description\": \"\",\n \"fieldMaskValues\": \"\",\n \"fieldWidth\": \"\",\n \"initiallyChecked\": \"\",\n \"isLabelToRight\": \"\",\n \"isMultiselect\": \"\",\n \"isRequired\": \"\",\n \"isSensitive\": \"\",\n \"labelWidth\": \"\",\n \"maxLength\": \"\",\n \"maximumNumber\": \"\",\n \"minimumNumber\": \"\",\n \"picklistValues\": \"\",\n \"placeholderText\": \"\",\n \"validationMessage\": \"\",\n \"visibleRows\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "437b8678-0063-41dc-9f3c-1c16f448eb8d", "name": "Get Available Form Program Member Fields", "request": { "name": "Get Available Form Program Member Fields", "description": { "content": "Retrieves a list of all valid Program Member fields for use in forms. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "form", "programMemberFields.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of fields to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "29448591-01c8-48b2-a36e-34ee3abc099a", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "form", "programMemberFields.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of fields to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"dataType\": \"\",\n \"defaultValue\": \"\",\n \"description\": \"\",\n \"fieldMaskValues\": \"\",\n \"fieldWidth\": \"\",\n \"initiallyChecked\": \"\",\n \"isLabelToRight\": \"\",\n \"isMultiselect\": \"\",\n \"isRequired\": \"\",\n \"isSensitive\": \"\",\n \"labelWidth\": \"\",\n \"maxLength\": \"\",\n \"maximumNumber\": \"\",\n \"minimumNumber\": \"\",\n \"picklistValues\": \"\",\n \"placeholderText\": \"\",\n \"validationMessage\": \"\",\n \"visibleRows\": \"\"\n },\n {\n \"id\": \"\",\n \"dataType\": \"\",\n \"defaultValue\": \"\",\n \"description\": \"\",\n \"fieldMaskValues\": \"\",\n \"fieldWidth\": \"\",\n \"initiallyChecked\": \"\",\n \"isLabelToRight\": \"\",\n \"isMultiselect\": \"\",\n \"isRequired\": \"\",\n \"isSensitive\": \"\",\n \"labelWidth\": \"\",\n \"maxLength\": \"\",\n \"maximumNumber\": \"\",\n \"minimumNumber\": \"\",\n \"picklistValues\": \"\",\n \"placeholderText\": \"\",\n \"validationMessage\": \"\",\n \"visibleRows\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d2a1c9ee-f022-412b-9d60-21aa19ff1f54", "name": "Add Form Field Visibility Rules", "request": { "name": "Add Form Field Visibility Rules", "description": { "content": "Adds a visibility rule to the target form field. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "form", ":formId", "field", ":fieldId", "visibility.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "formId", "disabled": false, "description": { "content": "(Required) formId", "type": "text/plain" } }, { "type": "any", "value": "", "key": "fieldId", "disabled": false, "description": { "content": "(Required) fieldId", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "ruleType", "value": "show" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "rules", "value": "[object Object],[object Object]" } ] }, "auth": null }, "response": [ { "id": "d2474f56-1d96-48bd-8e93-4596f65c5e16", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "form", ":formId", "field", ":fieldId", "visibility.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) formId", "type": "text/plain" }, "type": "any", "value": "", "key": "formId" }, { "disabled": false, "description": { "content": "(Required) fieldId", "type": "text/plain" }, "type": "any", "value": "", "key": "fieldId" } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "ruleType", "value": "show" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "rules", "value": "[object Object],[object Object]" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"formFieldId\": \"\",\n \"ruleType\": \"\",\n \"rules\": [\n {\n \"altLabel\": \"\",\n \"operator\": \"\",\n \"picklistFilterValues\": [\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n },\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n }\n ],\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"altLabel\": \"\",\n \"operator\": \"\",\n \"picklistFilterValues\": [\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n },\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n }\n ],\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\n \"formFieldId\": \"\",\n \"ruleType\": \"\",\n \"rules\": [\n {\n \"altLabel\": \"\",\n \"operator\": \"\",\n \"picklistFilterValues\": [\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n },\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n }\n ],\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"altLabel\": \"\",\n \"operator\": \"\",\n \"picklistFilterValues\": [\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n },\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n }\n ],\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e6af4e27-fa7c-435e-a3cc-1fbd4efa9923", "name": "Update Form Field", "request": { "name": "Update Form Field", "description": { "content": "Updates the configuration for that target field. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "form", ":id", "field", "{{fieldId}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "Number of blank fields to show when progressive profiling is enabled", "type": "text/plain" }, "key": "blankFields", "value": "" }, { "disabled": true, "description": { "content": "Optional default value for the field", "type": "text/plain" }, "key": "defaultValue", "value": "" }, { "disabled": true, "description": { "content": "Type of field", "type": "text/plain" }, "key": "fieldType", "value": "" }, { "disabled": true, "description": { "content": "Width of the input or select element", "type": "text/plain" }, "key": "fieldWidth", "value": "" }, { "disabled": true, "description": { "content": "Whether the field should prefill. Default true", "type": "text/plain" }, "key": "formPrefill", "value": "" }, { "disabled": true, "description": { "content": "Whether the field is marked as sensitive. Default false", "type": "text/plain" }, "key": "isSensitive", "value": "" }, { "disabled": true, "description": { "content": "Hint text for the field", "type": "text/plain" }, "key": "hintText", "value": "" }, { "disabled": true, "description": { "content": "Whether the field should be checked upon loading. Default false", "type": "text/plain" }, "key": "initiallyChecked", "value": "" }, { "disabled": true, "description": { "content": "Instructions for the field", "type": "text/plain" }, "key": "instructions", "value": "" }, { "disabled": true, "description": { "content": "Label of the field", "type": "text/plain" }, "key": "label", "value": "" }, { "disabled": true, "description": { "content": "Whether the field label should be displayed to the right of the input/select element. Default false", "type": "text/plain" }, "key": "labelToRight", "value": "" }, { "disabled": true, "description": { "content": "Width of the field label element", "type": "text/plain" }, "key": "labelWidth", "value": "" }, { "disabled": true, "description": { "content": "Optional input mask for the field", "type": "text/plain" }, "key": "maskInput", "value": "" }, { "disabled": true, "description": { "content": "Maximum length for text type fields", "type": "text/plain" }, "key": "maxLength", "value": "" }, { "disabled": true, "description": { "content": "Maximum value accepted by the field", "type": "text/plain" }, "key": "maxValue", "value": "" }, { "disabled": true, "description": { "content": "Minimum value accepted by the field", "type": "text/plain" }, "key": "minValue", "value": "" }, { "disabled": true, "description": { "content": "Whether the field should allow multiple selections. Default false", "type": "text/plain" }, "key": "multiSelect", "value": "" }, { "disabled": true, "description": { "content": "Whether the field is required to submit the form. Default false", "type": "text/plain" }, "key": "required", "value": "" }, { "disabled": true, "description": { "content": "Validation message to display on failed validation", "type": "text/plain" }, "key": "validationMessage", "value": "" }, { "disabled": true, "description": { "content": "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'}]", "type": "text/plain" }, "key": "values", "value": "" }, { "disabled": true, "description": { "content": "Number of lines to display for the field element", "type": "text/plain" }, "key": "visibleLines", "value": "" } ] }, "auth": null }, "response": [ { "id": "1fd8b7af-de7c-4827-a15c-fd795c58e497", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "form", ":id", "field", "{{fieldId}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "Number of blank fields to show when progressive profiling is enabled", "type": "text/plain" }, "key": "blankFields", "value": "" }, { "disabled": true, "description": { "content": "Optional default value for the field", "type": "text/plain" }, "key": "defaultValue", "value": "" }, { "disabled": true, "description": { "content": "Type of field", "type": "text/plain" }, "key": "fieldType", "value": "" }, { "disabled": true, "description": { "content": "Width of the input or select element", "type": "text/plain" }, "key": "fieldWidth", "value": "" }, { "disabled": true, "description": { "content": "Whether the field should prefill. Default true", "type": "text/plain" }, "key": "formPrefill", "value": "" }, { "disabled": true, "description": { "content": "Whether the field is marked as sensitive. Default false", "type": "text/plain" }, "key": "isSensitive", "value": "" }, { "disabled": true, "description": { "content": "Hint text for the field", "type": "text/plain" }, "key": "hintText", "value": "" }, { "disabled": true, "description": { "content": "Whether the field should be checked upon loading. Default false", "type": "text/plain" }, "key": "initiallyChecked", "value": "" }, { "disabled": true, "description": { "content": "Instructions for the field", "type": "text/plain" }, "key": "instructions", "value": "" }, { "disabled": true, "description": { "content": "Label of the field", "type": "text/plain" }, "key": "label", "value": "" }, { "disabled": true, "description": { "content": "Whether the field label should be displayed to the right of the input/select element. Default false", "type": "text/plain" }, "key": "labelToRight", "value": "" }, { "disabled": true, "description": { "content": "Width of the field label element", "type": "text/plain" }, "key": "labelWidth", "value": "" }, { "disabled": true, "description": { "content": "Optional input mask for the field", "type": "text/plain" }, "key": "maskInput", "value": "" }, { "disabled": true, "description": { "content": "Maximum length for text type fields", "type": "text/plain" }, "key": "maxLength", "value": "" }, { "disabled": true, "description": { "content": "Maximum value accepted by the field", "type": "text/plain" }, "key": "maxValue", "value": "" }, { "disabled": true, "description": { "content": "Minimum value accepted by the field", "type": "text/plain" }, "key": "minValue", "value": "" }, { "disabled": true, "description": { "content": "Whether the field should allow multiple selections. Default false", "type": "text/plain" }, "key": "multiSelect", "value": "" }, { "disabled": true, "description": { "content": "Whether the field is required to submit the form. Default false", "type": "text/plain" }, "key": "required", "value": "" }, { "disabled": true, "description": { "content": "Validation message to display on failed validation", "type": "text/plain" }, "key": "validationMessage", "value": "" }, { "disabled": true, "description": { "content": "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'}]", "type": "text/plain" }, "key": "values", "value": "" }, { "disabled": true, "description": { "content": "Number of lines to display for the field element", "type": "text/plain" }, "key": "visibleLines", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"blankFields\": \"\",\n \"columnNumber\": \"\",\n \"dataType\": \"\",\n \"defaultValue\": \"\",\n \"fieldMetaData\": {},\n \"fieldWidth\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"formPrefill\": \"\",\n \"isSensitive\": \"\",\n \"hintText\": \"\",\n \"id\": \"\",\n \"instructions\": \"\",\n \"label\": \"\",\n \"labelWidth\": \"\",\n \"maxLength\": \"\",\n \"required\": \"\",\n \"rowNumber\": \"\",\n \"text\": \"\",\n \"validationMessage\": {},\n \"visibilityRules\": {\n \"ruleType\": \"\",\n \"rules\": [\n {\n \"altLabel\": \"\",\n \"operator\": \"\",\n \"picklistFilterValues\": [\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n },\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n }\n ],\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"altLabel\": \"\",\n \"operator\": \"\",\n \"picklistFilterValues\": [\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n },\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n }\n ],\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n },\n {\n \"blankFields\": \"\",\n \"columnNumber\": \"\",\n \"dataType\": \"\",\n \"defaultValue\": \"\",\n \"fieldMetaData\": {},\n \"fieldWidth\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"formPrefill\": \"\",\n \"isSensitive\": \"\",\n \"hintText\": \"\",\n \"id\": \"\",\n \"instructions\": \"\",\n \"label\": \"\",\n \"labelWidth\": \"\",\n \"maxLength\": \"\",\n \"required\": \"\",\n \"rowNumber\": \"\",\n \"text\": \"\",\n \"validationMessage\": {},\n \"visibilityRules\": {\n \"ruleType\": \"\",\n \"rules\": [\n {\n \"altLabel\": \"\",\n \"operator\": \"\",\n \"picklistFilterValues\": [\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n },\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n }\n ],\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"altLabel\": \"\",\n \"operator\": \"\",\n \"picklistFilterValues\": [\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n },\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n }\n ],\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0e1303ed-bee3-4048-b346-7a5c52e42e08", "name": "Delete Form Field", "request": { "name": "Delete Form Field", "description": { "content": "Deletes a field from a form. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "form", ":id", "field", ":fieldId", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } }, { "type": "any", "value": "", "key": "fieldId", "disabled": false, "description": { "content": "(Required) fieldId", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "c6cf8096-3454-4151-a23f-0ffd88a1fa04", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "form", ":id", "field", ":fieldId", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) fieldId", "type": "text/plain" }, "type": "any", "value": "", "key": "fieldId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "56e7c8cc-a7bd-4e0c-96a4-bf3b4e6710f4", "name": "Add Fieldset to Form", "request": { "name": "Add Fieldset to Form", "description": { "content": "Adds a field set to the target form. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "form", ":id", "fieldSet.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Label of the fieldset", "type": "text/plain" }, "key": "label", "value": "" } ] }, "auth": null }, "response": [ { "id": "744ba44b-b66b-4f11-b7ab-e0413afc8041", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "form", ":id", "fieldSet.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Label of the fieldset", "type": "text/plain" }, "key": "label", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"blankFields\": \"\",\n \"columnNumber\": \"\",\n \"dataType\": \"\",\n \"defaultValue\": \"\",\n \"fieldMetaData\": {},\n \"fieldWidth\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"formPrefill\": \"\",\n \"isSensitive\": \"\",\n \"hintText\": \"\",\n \"id\": \"\",\n \"instructions\": \"\",\n \"label\": \"\",\n \"labelWidth\": \"\",\n \"maxLength\": \"\",\n \"required\": \"\",\n \"rowNumber\": \"\",\n \"text\": \"\",\n \"validationMessage\": {},\n \"visibilityRules\": {\n \"ruleType\": \"\",\n \"rules\": [\n {\n \"altLabel\": \"\",\n \"operator\": \"\",\n \"picklistFilterValues\": [\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n },\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n }\n ],\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"altLabel\": \"\",\n \"operator\": \"\",\n \"picklistFilterValues\": [\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n },\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n }\n ],\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n },\n {\n \"blankFields\": \"\",\n \"columnNumber\": \"\",\n \"dataType\": \"\",\n \"defaultValue\": \"\",\n \"fieldMetaData\": {},\n \"fieldWidth\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"formPrefill\": \"\",\n \"isSensitive\": \"\",\n \"hintText\": \"\",\n \"id\": \"\",\n \"instructions\": \"\",\n \"label\": \"\",\n \"labelWidth\": \"\",\n \"maxLength\": \"\",\n \"required\": \"\",\n \"rowNumber\": \"\",\n \"text\": \"\",\n \"validationMessage\": {},\n \"visibilityRules\": {\n \"ruleType\": \"\",\n \"rules\": [\n {\n \"altLabel\": \"\",\n \"operator\": \"\",\n \"picklistFilterValues\": [\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n },\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n }\n ],\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"altLabel\": \"\",\n \"operator\": \"\",\n \"picklistFilterValues\": [\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n },\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n }\n ],\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3b71a131-c4ab-4e7b-91ca-84e125fd2d8e", "name": "Delete Field from Fieldset", "request": { "name": "Delete Field from Fieldset", "description": { "content": "Removes the target field from the fieldset. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "form", ":id", "fieldSet", ":fieldSetId", "field", ":fieldId", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } }, { "type": "any", "value": "", "key": "fieldSetId", "disabled": false, "description": { "content": "(Required) fieldSetId", "type": "text/plain" } }, { "type": "any", "value": "", "key": "fieldId", "disabled": false, "description": { "content": "(Required) fieldId", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "35fd088a-0321-4a7c-90dd-6275d3239445", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "form", ":id", "fieldSet", ":fieldSetId", "field", ":fieldId", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) fieldSetId", "type": "text/plain" }, "type": "any", "value": "", "key": "fieldSetId" }, { "disabled": false, "description": { "content": "(Required) fieldId", "type": "text/plain" }, "type": "any", "value": "", "key": "fieldId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "03901e86-5e4f-4677-a165-ac4a7a05b3ba", "name": "Get Fields for Form", "request": { "name": "Get Fields for Form", "description": { "content": "Retrieves the list of fields in the target form. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "form", ":id", "fields.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b7a8131e-fda0-45d9-a998-fcf4adffa41e", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "form", ":id", "fields.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"blankFields\": \"\",\n \"columnNumber\": \"\",\n \"dataType\": \"\",\n \"defaultValue\": \"\",\n \"fieldMetaData\": {},\n \"fieldWidth\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"formPrefill\": \"\",\n \"isSensitive\": \"\",\n \"hintText\": \"\",\n \"id\": \"\",\n \"instructions\": \"\",\n \"label\": \"\",\n \"labelWidth\": \"\",\n \"maxLength\": \"\",\n \"required\": \"\",\n \"rowNumber\": \"\",\n \"text\": \"\",\n \"validationMessage\": {},\n \"visibilityRules\": {\n \"ruleType\": \"\",\n \"rules\": [\n {\n \"altLabel\": \"\",\n \"operator\": \"\",\n \"picklistFilterValues\": [\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n },\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n }\n ],\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"altLabel\": \"\",\n \"operator\": \"\",\n \"picklistFilterValues\": [\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n },\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n }\n ],\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n },\n {\n \"blankFields\": \"\",\n \"columnNumber\": \"\",\n \"dataType\": \"\",\n \"defaultValue\": \"\",\n \"fieldMetaData\": {},\n \"fieldWidth\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"formPrefill\": \"\",\n \"isSensitive\": \"\",\n \"hintText\": \"\",\n \"id\": \"\",\n \"instructions\": \"\",\n \"label\": \"\",\n \"labelWidth\": \"\",\n \"maxLength\": \"\",\n \"required\": \"\",\n \"rowNumber\": \"\",\n \"text\": \"\",\n \"validationMessage\": {},\n \"visibilityRules\": {\n \"ruleType\": \"\",\n \"rules\": [\n {\n \"altLabel\": \"\",\n \"operator\": \"\",\n \"picklistFilterValues\": [\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n },\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n }\n ],\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"altLabel\": \"\",\n \"operator\": \"\",\n \"picklistFilterValues\": [\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n },\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n }\n ],\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1eb031a5-40ec-4e3e-b73d-b234ac92aeec", "name": "Add Field to Form", "request": { "name": "Add Field to Form", "description": { "content": "Adds a field to a form. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "form", ":id", "fields.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Id of the field", "type": "text/plain" }, "key": "fieldId", "value": "" }, { "disabled": true, "description": { "content": "Number of blank fields to show when progressive profiling is enabled", "type": "text/plain" }, "key": "blankFields", "value": "" }, { "disabled": true, "description": { "content": "Optional default value for the field", "type": "text/plain" }, "key": "defaultValue", "value": "" }, { "disabled": true, "description": { "content": "Specifies the field type.", "type": "text/plain" }, "key": "fieldType", "value": "" }, { "disabled": true, "description": { "content": "Width of the input or select element", "type": "text/plain" }, "key": "fieldWidth", "value": "" }, { "disabled": true, "description": { "content": "Whether the field should prefill. Default true", "type": "text/plain" }, "key": "formPrefill", "value": "" }, { "disabled": true, "description": { "content": "Whether the field is marked as sensitive. Default false", "type": "text/plain" }, "key": "isSensitive", "value": "" }, { "disabled": true, "description": { "content": "Hint text for the field", "type": "text/plain" }, "key": "hintText", "value": "" }, { "disabled": true, "description": { "content": "Whether the field should be checked upon loading. Default false", "type": "text/plain" }, "key": "initiallyChecked", "value": "" }, { "disabled": true, "description": { "content": "Instructions for the field", "type": "text/plain" }, "key": "instructions", "value": "" }, { "disabled": true, "description": { "content": "Label of the field", "type": "text/plain" }, "key": "label", "value": "" }, { "disabled": true, "description": { "content": "Whether the field label should be displayed to the right of the input/select element. Default false", "type": "text/plain" }, "key": "labelToRight", "value": "" }, { "disabled": true, "description": { "content": "Width of the field label element", "type": "text/plain" }, "key": "labelWidth", "value": "" }, { "disabled": true, "description": { "content": "Optional input mask for the field", "type": "text/plain" }, "key": "maskInput", "value": "" }, { "disabled": true, "description": { "content": "Maximum length for text type fields", "type": "text/plain" }, "key": "maxLength", "value": "" }, { "disabled": true, "description": { "content": "Maximum value accepted by the field", "type": "text/plain" }, "key": "maxValue", "value": "" }, { "disabled": true, "description": { "content": "Minimum value accepted by the field", "type": "text/plain" }, "key": "minValue", "value": "" }, { "disabled": true, "description": { "content": "Whether the field should allow multiple selections. Default false", "type": "text/plain" }, "key": "multiSelect", "value": "" }, { "disabled": true, "description": { "content": "Whether the field is required to submit the form. Default false", "type": "text/plain" }, "key": "required", "value": "" }, { "disabled": true, "description": { "content": "Validation message to display on failed validation", "type": "text/plain" }, "key": "validationMessage", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated list of accepted values for the field. Only for select-field types", "type": "text/plain" }, "key": "values", "value": "" }, { "disabled": true, "description": { "content": "Number of lines to display for the field element", "type": "text/plain" }, "key": "visibleLines", "value": "" } ] }, "auth": null }, "response": [ { "id": "037ed630-cb2f-4b6e-8338-6f46bff4fb2a", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "form", ":id", "fields.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Id of the field", "type": "text/plain" }, "key": "fieldId", "value": "" }, { "disabled": true, "description": { "content": "Number of blank fields to show when progressive profiling is enabled", "type": "text/plain" }, "key": "blankFields", "value": "" }, { "disabled": true, "description": { "content": "Optional default value for the field", "type": "text/plain" }, "key": "defaultValue", "value": "" }, { "disabled": true, "description": { "content": "Specifies the field type.", "type": "text/plain" }, "key": "fieldType", "value": "" }, { "disabled": true, "description": { "content": "Width of the input or select element", "type": "text/plain" }, "key": "fieldWidth", "value": "" }, { "disabled": true, "description": { "content": "Whether the field should prefill. Default true", "type": "text/plain" }, "key": "formPrefill", "value": "" }, { "disabled": true, "description": { "content": "Whether the field is marked as sensitive. Default false", "type": "text/plain" }, "key": "isSensitive", "value": "" }, { "disabled": true, "description": { "content": "Hint text for the field", "type": "text/plain" }, "key": "hintText", "value": "" }, { "disabled": true, "description": { "content": "Whether the field should be checked upon loading. Default false", "type": "text/plain" }, "key": "initiallyChecked", "value": "" }, { "disabled": true, "description": { "content": "Instructions for the field", "type": "text/plain" }, "key": "instructions", "value": "" }, { "disabled": true, "description": { "content": "Label of the field", "type": "text/plain" }, "key": "label", "value": "" }, { "disabled": true, "description": { "content": "Whether the field label should be displayed to the right of the input/select element. Default false", "type": "text/plain" }, "key": "labelToRight", "value": "" }, { "disabled": true, "description": { "content": "Width of the field label element", "type": "text/plain" }, "key": "labelWidth", "value": "" }, { "disabled": true, "description": { "content": "Optional input mask for the field", "type": "text/plain" }, "key": "maskInput", "value": "" }, { "disabled": true, "description": { "content": "Maximum length for text type fields", "type": "text/plain" }, "key": "maxLength", "value": "" }, { "disabled": true, "description": { "content": "Maximum value accepted by the field", "type": "text/plain" }, "key": "maxValue", "value": "" }, { "disabled": true, "description": { "content": "Minimum value accepted by the field", "type": "text/plain" }, "key": "minValue", "value": "" }, { "disabled": true, "description": { "content": "Whether the field should allow multiple selections. Default false", "type": "text/plain" }, "key": "multiSelect", "value": "" }, { "disabled": true, "description": { "content": "Whether the field is required to submit the form. Default false", "type": "text/plain" }, "key": "required", "value": "" }, { "disabled": true, "description": { "content": "Validation message to display on failed validation", "type": "text/plain" }, "key": "validationMessage", "value": "" }, { "disabled": true, "description": { "content": "Comma-separated list of accepted values for the field. Only for select-field types", "type": "text/plain" }, "key": "values", "value": "" }, { "disabled": true, "description": { "content": "Number of lines to display for the field element", "type": "text/plain" }, "key": "visibleLines", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"blankFields\": \"\",\n \"columnNumber\": \"\",\n \"dataType\": \"\",\n \"defaultValue\": \"\",\n \"fieldMetaData\": {},\n \"fieldWidth\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"formPrefill\": \"\",\n \"isSensitive\": \"\",\n \"hintText\": \"\",\n \"id\": \"\",\n \"instructions\": \"\",\n \"label\": \"\",\n \"labelWidth\": \"\",\n \"maxLength\": \"\",\n \"required\": \"\",\n \"rowNumber\": \"\",\n \"text\": \"\",\n \"validationMessage\": {},\n \"visibilityRules\": {\n \"ruleType\": \"\",\n \"rules\": [\n {\n \"altLabel\": \"\",\n \"operator\": \"\",\n \"picklistFilterValues\": [\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n },\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n }\n ],\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"altLabel\": \"\",\n \"operator\": \"\",\n \"picklistFilterValues\": [\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n },\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n }\n ],\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n },\n {\n \"blankFields\": \"\",\n \"columnNumber\": \"\",\n \"dataType\": \"\",\n \"defaultValue\": \"\",\n \"fieldMetaData\": {},\n \"fieldWidth\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"formPrefill\": \"\",\n \"isSensitive\": \"\",\n \"hintText\": \"\",\n \"id\": \"\",\n \"instructions\": \"\",\n \"label\": \"\",\n \"labelWidth\": \"\",\n \"maxLength\": \"\",\n \"required\": \"\",\n \"rowNumber\": \"\",\n \"text\": \"\",\n \"validationMessage\": {},\n \"visibilityRules\": {\n \"ruleType\": \"\",\n \"rules\": [\n {\n \"altLabel\": \"\",\n \"operator\": \"\",\n \"picklistFilterValues\": [\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n },\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n }\n ],\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"altLabel\": \"\",\n \"operator\": \"\",\n \"picklistFilterValues\": [\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n },\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n }\n ],\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aa89e149-9491-4541-bef7-9e3ed32cd23c", "name": "Update Field Positions", "request": { "name": "Update Field Positions", "description": { "content": "Reorders the list of fields in a form. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "form", ":id", "reArrange.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "positions", "value": "[object Object]" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "positions", "value": "[object Object]" } ] }, "auth": null }, "response": [ { "id": "2fb95854-89d0-4c08-85cb-4e90fb523164", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "form", ":id", "reArrange.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "positions", "value": "[object Object]" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "positions", "value": "[object Object]" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a3442d7c-2a35-407a-9c82-e77ccda85ee8", "name": "Add Rich Text Field", "request": { "name": "Add Rich Text Field", "description": { "content": "Adds a rich-text type field to the form. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "form", ":id", "richText.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Multipart file. HTML Content for the rich text field.", "type": "text/plain" }, "key": "text", "value": "" } ] }, "auth": null }, "response": [ { "id": "81d3d591-1ca6-4bc4-81ee-3ac61209315f", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "form", ":id", "richText.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Multipart file. HTML Content for the rich text field.", "type": "text/plain" }, "key": "text", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"blankFields\": \"\",\n \"columnNumber\": \"\",\n \"dataType\": \"\",\n \"defaultValue\": \"\",\n \"fieldMetaData\": {},\n \"fieldWidth\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"formPrefill\": \"\",\n \"isSensitive\": \"\",\n \"hintText\": \"\",\n \"id\": \"\",\n \"instructions\": \"\",\n \"label\": \"\",\n \"labelWidth\": \"\",\n \"maxLength\": \"\",\n \"required\": \"\",\n \"rowNumber\": \"\",\n \"text\": \"\",\n \"validationMessage\": {},\n \"visibilityRules\": {\n \"ruleType\": \"\",\n \"rules\": [\n {\n \"altLabel\": \"\",\n \"operator\": \"\",\n \"picklistFilterValues\": [\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n },\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n }\n ],\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"altLabel\": \"\",\n \"operator\": \"\",\n \"picklistFilterValues\": [\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n },\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n }\n ],\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n },\n {\n \"blankFields\": \"\",\n \"columnNumber\": \"\",\n \"dataType\": \"\",\n \"defaultValue\": \"\",\n \"fieldMetaData\": {},\n \"fieldWidth\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"formPrefill\": \"\",\n \"isSensitive\": \"\",\n \"hintText\": \"\",\n \"id\": \"\",\n \"instructions\": \"\",\n \"label\": \"\",\n \"labelWidth\": \"\",\n \"maxLength\": \"\",\n \"required\": \"\",\n \"rowNumber\": \"\",\n \"text\": \"\",\n \"validationMessage\": {},\n \"visibilityRules\": {\n \"ruleType\": \"\",\n \"rules\": [\n {\n \"altLabel\": \"\",\n \"operator\": \"\",\n \"picklistFilterValues\": [\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n },\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n }\n ],\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"altLabel\": \"\",\n \"operator\": \"\",\n \"picklistFilterValues\": [\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n },\n {\n \"isDefault\": \"\",\n \"label\": \"\",\n \"selected\": \"\",\n \"value\": \"\"\n }\n ],\n \"subjectField\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Programs", "description": "CRUD operations on programs, including cloning, approval, tags, costs, and channel assignment.", "item": [ { "id": "9c184a49-0109-4c58-9851-d1dc58f9b489", "name": "Get Program by Name", "request": { "name": "Get Program by Name", "description": { "content": "Retrieves the program record for the given name. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "program", "byName.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Name of the program", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Set true to populate program tags", "type": "text/plain" }, "key": "includeTags", "value": "" }, { "disabled": true, "description": { "content": "Set true to populate program costs", "type": "text/plain" }, "key": "includeCosts", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "58849676-869d-44fa-8cb7-67d01dd66015", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "program", "byName.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Name of the program", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Set true to populate program tags", "type": "text/plain" }, "key": "includeTags", "value": "" }, { "disabled": true, "description": { "content": "Set true to populate program costs", "type": "text/plain" }, "key": "includeCosts", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"channel\": \"\",\n \"costs\": [\n {\n \"cost\": \"\",\n \"startDate\": \"\",\n \"note\": \"\"\n },\n {\n \"cost\": \"\",\n \"startDate\": \"\",\n \"note\": \"\"\n }\n ],\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"status\": \"off\",\n \"tags\": [\n {\n \"tagType\": \"\",\n \"tagValue\": \"\"\n },\n {\n \"tagType\": \"\",\n \"tagValue\": \"\"\n }\n ],\n \"type\": \"event\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"endDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"sfdcId\": \"\",\n \"sfdcName\": \"\",\n \"startDate\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n },\n {\n \"channel\": \"\",\n \"costs\": [\n {\n \"cost\": \"\",\n \"startDate\": \"\",\n \"note\": \"\"\n },\n {\n \"cost\": \"\",\n \"startDate\": \"\",\n \"note\": \"\"\n }\n ],\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"status\": \"locked\",\n \"tags\": [\n {\n \"tagType\": \"\",\n \"tagValue\": \"\"\n },\n {\n \"tagType\": \"\",\n \"tagValue\": \"\"\n }\n ],\n \"type\": \"event\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"endDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"sfdcId\": \"\",\n \"sfdcName\": \"\",\n \"startDate\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e22d1469-ae82-4aab-9b37-a8c0b0316b7c", "name": "Get Programs by Tag", "request": { "name": "Get Programs by Tag", "description": { "content": "Retrieves a list of programs matching the tag type and tag values given. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "program", "byTag.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Type of program tag", "type": "text/plain" }, "key": "tagType", "value": "" }, { "disabled": false, "description": { "content": "(Required) Value of the tag", "type": "text/plain" }, "key": "tagValue", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of records to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d029ad3e-75a6-4012-b41a-17ffdf976de3", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "program", "byTag.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Type of program tag", "type": "text/plain" }, "key": "tagType", "value": "" }, { "disabled": false, "description": { "content": "(Required) Value of the tag", "type": "text/plain" }, "key": "tagValue", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of records to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"channel\": \"\",\n \"costs\": [\n {\n \"cost\": \"\",\n \"startDate\": \"\",\n \"note\": \"\"\n },\n {\n \"cost\": \"\",\n \"startDate\": \"\",\n \"note\": \"\"\n }\n ],\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"status\": \"off\",\n \"tags\": [\n {\n \"tagType\": \"\",\n \"tagValue\": \"\"\n },\n {\n \"tagType\": \"\",\n \"tagValue\": \"\"\n }\n ],\n \"type\": \"event\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"endDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"sfdcId\": \"\",\n \"sfdcName\": \"\",\n \"startDate\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n },\n {\n \"channel\": \"\",\n \"costs\": [\n {\n \"cost\": \"\",\n \"startDate\": \"\",\n \"note\": \"\"\n },\n {\n \"cost\": \"\",\n \"startDate\": \"\",\n \"note\": \"\"\n }\n ],\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"status\": \"locked\",\n \"tags\": [\n {\n \"tagType\": \"\",\n \"tagValue\": \"\"\n },\n {\n \"tagType\": \"\",\n \"tagValue\": \"\"\n }\n ],\n \"type\": \"event\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"endDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"sfdcId\": \"\",\n \"sfdcName\": \"\",\n \"startDate\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a6b660f9-b648-458b-bf86-c28523d2668d", "name": "Get Program by Id", "request": { "name": "Get Program by Id", "description": { "content": "Retrieves the program record for the given id. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "program", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9171a236-f795-4932-8434-2f0818566dd7", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "program", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"channel\": \"\",\n \"costs\": [\n {\n \"cost\": \"\",\n \"startDate\": \"\",\n \"note\": \"\"\n },\n {\n \"cost\": \"\",\n \"startDate\": \"\",\n \"note\": \"\"\n }\n ],\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"status\": \"off\",\n \"tags\": [\n {\n \"tagType\": \"\",\n \"tagValue\": \"\"\n },\n {\n \"tagType\": \"\",\n \"tagValue\": \"\"\n }\n ],\n \"type\": \"event\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"endDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"sfdcId\": \"\",\n \"sfdcName\": \"\",\n \"startDate\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n },\n {\n \"channel\": \"\",\n \"costs\": [\n {\n \"cost\": \"\",\n \"startDate\": \"\",\n \"note\": \"\"\n },\n {\n \"cost\": \"\",\n \"startDate\": \"\",\n \"note\": \"\"\n }\n ],\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"status\": \"locked\",\n \"tags\": [\n {\n \"tagType\": \"\",\n \"tagValue\": \"\"\n },\n {\n \"tagType\": \"\",\n \"tagValue\": \"\"\n }\n ],\n \"type\": \"event\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"endDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"sfdcId\": \"\",\n \"sfdcName\": \"\",\n \"startDate\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f5629758-aa92-4dc1-aba4-eae57379b56c", "name": "Update Program Metadata", "request": { "name": "Update Program Metadata", "description": { "content": "Updates the target program's metadata. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "program", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "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", "type": "text/plain" }, "key": "costs", "value": "[object Object]" }, { "disabled": true, "description": { "content": "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", "type": "text/plain" }, "key": "costs", "value": "[object Object]" }, { "disabled": true, "description": { "content": "Set true to destroy existing costs and replace them with the specified costs", "type": "text/plain" }, "key": "costsDestructiveUpdate", "value": "" }, { "disabled": true, "description": { "content": "Updated description for the program", "type": "text/plain" }, "key": "description", "value": "" }, { "disabled": true, "description": { "content": "End date of the program. Applicable to event, email, and webinar type programs", "type": "text/plain" }, "key": "endDate", "value": "" }, { "disabled": true, "description": { "content": "Name of the program", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Start date of program. Applicable to event, email and webinar type programs", "type": "text/plain" }, "key": "startDate", "value": "" }, { "disabled": true, "description": { "content": "List of associated program tags", "type": "text/plain" }, "key": "tags", "value": "[object Object]" }, { "disabled": true, "description": { "content": "List of associated program tags", "type": "text/plain" }, "key": "tags", "value": "[object Object]" } ] }, "auth": null }, "response": [ { "id": "1b7929ed-7feb-42b1-94cb-7a8c49cc66df", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "program", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "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", "type": "text/plain" }, "key": "costs", "value": "[object Object]" }, { "disabled": true, "description": { "content": "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", "type": "text/plain" }, "key": "costs", "value": "[object Object]" }, { "disabled": true, "description": { "content": "Set true to destroy existing costs and replace them with the specified costs", "type": "text/plain" }, "key": "costsDestructiveUpdate", "value": "" }, { "disabled": true, "description": { "content": "Updated description for the program", "type": "text/plain" }, "key": "description", "value": "" }, { "disabled": true, "description": { "content": "End date of the program. Applicable to event, email, and webinar type programs", "type": "text/plain" }, "key": "endDate", "value": "" }, { "disabled": true, "description": { "content": "Name of the program", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Start date of program. Applicable to event, email and webinar type programs", "type": "text/plain" }, "key": "startDate", "value": "" }, { "disabled": true, "description": { "content": "List of associated program tags", "type": "text/plain" }, "key": "tags", "value": "[object Object]" }, { "disabled": true, "description": { "content": "List of associated program tags", "type": "text/plain" }, "key": "tags", "value": "[object Object]" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"channel\": \"\",\n \"costs\": [\n {\n \"cost\": \"\",\n \"startDate\": \"\",\n \"note\": \"\"\n },\n {\n \"cost\": \"\",\n \"startDate\": \"\",\n \"note\": \"\"\n }\n ],\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"status\": \"off\",\n \"tags\": [\n {\n \"tagType\": \"\",\n \"tagValue\": \"\"\n },\n {\n \"tagType\": \"\",\n \"tagValue\": \"\"\n }\n ],\n \"type\": \"event\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"endDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"sfdcId\": \"\",\n \"sfdcName\": \"\",\n \"startDate\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n },\n {\n \"channel\": \"\",\n \"costs\": [\n {\n \"cost\": \"\",\n \"startDate\": \"\",\n \"note\": \"\"\n },\n {\n \"cost\": \"\",\n \"startDate\": \"\",\n \"note\": \"\"\n }\n ],\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"status\": \"locked\",\n \"tags\": [\n {\n \"tagType\": \"\",\n \"tagValue\": \"\"\n },\n {\n \"tagType\": \"\",\n \"tagValue\": \"\"\n }\n ],\n \"type\": \"event\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"endDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"sfdcId\": \"\",\n \"sfdcName\": \"\",\n \"startDate\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8a651535-aca3-470c-9e69-ab7a183bc6fd", "name": "Approve Program", "request": { "name": "Approve Program", "description": { "content": "Approves the target program. Only valid for unapproved email programs. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "program", ":id", "approve.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "e23ae5b5-49fd-4e7f-933b-108ae1bad2b2", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "program", ":id", "approve.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1faca8e0-b3e4-4d9b-8d1b-54522713e4d3", "name": "Clone Program", "request": { "name": "Clone Program", "description": { "content": "Clones the target program. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "program", ":id", "clone.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "type", "value": "Folder" }, { "disabled": false, "description": { "content": "(Required) Name of the program. Max 255 characters", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "" } ] }, "auth": null }, "response": [ { "id": "e28f76f4-af96-47f9-842f-084fb622b72f", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "program", ":id", "clone.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "type", "value": "Folder" }, { "disabled": false, "description": { "content": "(Required) Name of the program. Max 255 characters", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"channel\": \"\",\n \"costs\": [\n {\n \"cost\": \"\",\n \"startDate\": \"\",\n \"note\": \"\"\n },\n {\n \"cost\": \"\",\n \"startDate\": \"\",\n \"note\": \"\"\n }\n ],\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"status\": \"off\",\n \"tags\": [\n {\n \"tagType\": \"\",\n \"tagValue\": \"\"\n },\n {\n \"tagType\": \"\",\n \"tagValue\": \"\"\n }\n ],\n \"type\": \"event\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"endDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"sfdcId\": \"\",\n \"sfdcName\": \"\",\n \"startDate\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n },\n {\n \"channel\": \"\",\n \"costs\": [\n {\n \"cost\": \"\",\n \"startDate\": \"\",\n \"note\": \"\"\n },\n {\n \"cost\": \"\",\n \"startDate\": \"\",\n \"note\": \"\"\n }\n ],\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"status\": \"locked\",\n \"tags\": [\n {\n \"tagType\": \"\",\n \"tagValue\": \"\"\n },\n {\n \"tagType\": \"\",\n \"tagValue\": \"\"\n }\n ],\n \"type\": \"event\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"endDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"sfdcId\": \"\",\n \"sfdcName\": \"\",\n \"startDate\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5703c5af-01df-40c6-a218-b9bb55a448d1", "name": "Delete Program", "request": { "name": "Delete Program", "description": { "content": "Deletes the target program. The program may not contain any assets which are in use outside the program. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "program", ":id", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "35260a06-b76f-473f-9509-b3f1a494df9b", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "program", ":id", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ffccd1cc-645b-4305-aff9-c59bb03ce1df", "name": "Unapprove Program", "request": { "name": "Unapprove Program", "description": { "content": "Unapproves the target program. Only valid for approved email programs. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "program", ":id", "unapprove.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "6bb92a7f-0a44-4e4a-a201-119e6309dc90", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "program", ":id", "unapprove.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fb7f7848-e23f-47e7-a492-1906a7317e7f", "name": "Get Smart List by Program Id", "request": { "name": "Get Smart List by Program Id", "description": { "content": "Retrieves a Smart List record by its Email Program id. Required Permissions: Read-Asset or Read-Write Asset", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "program", ":programId", "smartList.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Set true to populate smart list rules. Default false", "type": "text/plain" }, "key": "includeRules", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "programId", "disabled": false, "description": { "content": "(Required) Id for the email program containing smart list to retrieve", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "bad0028c-90bd-4513-957e-1bf7c507e2fd", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "program", ":programId", "smartList.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Set true to populate smart list rules. Default false", "type": "text/plain" }, "key": "includeRules", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Id for the email program containing smart list to retrieve", "type": "text/plain" }, "type": "any", "value": "", "key": "programId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"workspace\": \"\",\n \"rules\": {\n \"filterMatchType\": \"Any\",\n \"triggers\": [\n \"\",\n \"\"\n ],\n \"filters\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"ruleTypeId\": \"\",\n \"ruleType\": \"\",\n \"operator\": \"\",\n \"conditions\": [\n {\n \"activityAttributeId\": \"\",\n \"activityAttributeName\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"isPrimary\": \"\"\n },\n {\n \"activityAttributeId\": \"\",\n \"activityAttributeName\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"isPrimary\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"ruleTypeId\": \"\",\n \"ruleType\": \"\",\n \"operator\": \"\",\n \"conditions\": [\n {\n \"activityAttributeId\": \"\",\n \"activityAttributeName\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"isPrimary\": \"\"\n },\n {\n \"activityAttributeId\": \"\",\n \"activityAttributeName\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"isPrimary\": \"\"\n }\n ]\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"workspace\": \"\",\n \"rules\": {\n \"filterMatchType\": \"Advanced\",\n \"triggers\": [\n \"\",\n \"\"\n ],\n \"filters\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"ruleTypeId\": \"\",\n \"ruleType\": \"\",\n \"operator\": \"\",\n \"conditions\": [\n {\n \"activityAttributeId\": \"\",\n \"activityAttributeName\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"isPrimary\": \"\"\n },\n {\n \"activityAttributeId\": \"\",\n \"activityAttributeName\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"isPrimary\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"ruleTypeId\": \"\",\n \"ruleType\": \"\",\n \"operator\": \"\",\n \"conditions\": [\n {\n \"activityAttributeId\": \"\",\n \"activityAttributeName\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"isPrimary\": \"\"\n },\n {\n \"activityAttributeId\": \"\",\n \"activityAttributeName\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"isPrimary\": \"\"\n }\n ]\n }\n ]\n }\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6e374862-3ba4-498c-991f-7f58c189b486", "name": "Get Programs", "request": { "name": "Get Programs", "description": { "content": "Retrieves the list of accessible programs from the target instance. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "programs.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of records to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Optional filter. Requires filterValues (This can only be one of id,programId,folderId,workspace)", "type": "text/plain" }, "key": "filterType", "value": "programId" }, { "disabled": true, "description": { "content": "Exclude programs prior to this date. Must be valid ISO-8601 string. See Datetime field type description.", "type": "text/plain" }, "key": "earliestUpdatedAt", "value": "" }, { "disabled": true, "description": { "content": "Exclude programs after this date. Must be valid ISO-8601 string. See Datetime field type description.", "type": "text/plain" }, "key": "latestUpdatedAt", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9a3a9180-a00b-4b82-95e8-3500bad23d6d", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "programs.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of records to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Optional filter. Requires filterValues (This can only be one of id,programId,folderId,workspace)", "type": "text/plain" }, "key": "filterType", "value": "programId" }, { "disabled": true, "description": { "content": "Exclude programs prior to this date. Must be valid ISO-8601 string. See Datetime field type description.", "type": "text/plain" }, "key": "earliestUpdatedAt", "value": "" }, { "disabled": true, "description": { "content": "Exclude programs after this date. Must be valid ISO-8601 string. See Datetime field type description.", "type": "text/plain" }, "key": "latestUpdatedAt", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"channel\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"status\": \"off\",\n \"type\": \"event\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"sfdcId\": \"\",\n \"sfdcName\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n },\n {\n \"channel\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"status\": \"off\",\n \"type\": \"webinar\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"sfdcId\": \"\",\n \"sfdcName\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0b7605e3-30a8-4bac-a956-e22c10f04611", "name": "Create Program", "request": { "name": "Create Program", "description": { "content": "Creates a new program. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "programs.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "type", "value": "Program" }, { "disabled": false, "description": { "content": "(Required) Name of the program", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": false, "description": { "content": "(Required) Type of the program", "type": "text/plain" }, "key": "type", "value": "" }, { "disabled": false, "description": { "content": "(Required) Channel of the program", "type": "text/plain" }, "key": "channel", "value": "" }, { "disabled": true, "description": { "content": "Lists of associated period costs", "type": "text/plain" }, "key": "costs", "value": "[object Object]" }, { "disabled": true, "description": { "content": "Lists of associated period costs", "type": "text/plain" }, "key": "costs", "value": "[object Object]" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "" }, { "disabled": true, "description": { "content": "List of associated program tags", "type": "text/plain" }, "key": "tags", "value": "[object Object]" }, { "disabled": true, "description": { "content": "List of associated program tags", "type": "text/plain" }, "key": "tags", "value": "[object Object]" } ] }, "auth": null }, "response": [ { "id": "2017d1c6-d46c-4a56-ba4b-19cb9a72fed6", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "programs.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "type", "value": "Program" }, { "disabled": false, "description": { "content": "(Required) Name of the program", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": false, "description": { "content": "(Required) Type of the program", "type": "text/plain" }, "key": "type", "value": "" }, { "disabled": false, "description": { "content": "(Required) Channel of the program", "type": "text/plain" }, "key": "channel", "value": "" }, { "disabled": true, "description": { "content": "Lists of associated period costs", "type": "text/plain" }, "key": "costs", "value": "[object Object]" }, { "disabled": true, "description": { "content": "Lists of associated period costs", "type": "text/plain" }, "key": "costs", "value": "[object Object]" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "" }, { "disabled": true, "description": { "content": "List of associated program tags", "type": "text/plain" }, "key": "tags", "value": "[object Object]" }, { "disabled": true, "description": { "content": "List of associated program tags", "type": "text/plain" }, "key": "tags", "value": "[object Object]" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"channel\": \"\",\n \"costs\": [\n {\n \"cost\": \"\",\n \"startDate\": \"\",\n \"note\": \"\"\n },\n {\n \"cost\": \"\",\n \"startDate\": \"\",\n \"note\": \"\"\n }\n ],\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"status\": \"off\",\n \"tags\": [\n {\n \"tagType\": \"\",\n \"tagValue\": \"\"\n },\n {\n \"tagType\": \"\",\n \"tagValue\": \"\"\n }\n ],\n \"type\": \"event\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"endDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"sfdcId\": \"\",\n \"sfdcName\": \"\",\n \"startDate\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n },\n {\n \"channel\": \"\",\n \"costs\": [\n {\n \"cost\": \"\",\n \"startDate\": \"\",\n \"note\": \"\"\n },\n {\n \"cost\": \"\",\n \"startDate\": \"\",\n \"note\": \"\"\n }\n ],\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"status\": \"locked\",\n \"tags\": [\n {\n \"tagType\": \"\",\n \"tagValue\": \"\"\n },\n {\n \"tagType\": \"\",\n \"tagValue\": \"\"\n }\n ],\n \"type\": \"event\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"endDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"sfdcId\": \"\",\n \"sfdcName\": \"\",\n \"startDate\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Smart Campaigns", "description": "CRUD operations on Smart Campaigns, including activation, deactivation, cloning, and schedule.", "item": [ { "id": "f516732f-a00d-4c5e-b196-76a93a376185", "name": "Get Smart Campaign by Name", "request": { "name": "Get Smart Campaign by Name", "description": { "content": "Returns the smart campaign for the given name. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "smartCampaign", "byName.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Name for the smart campaign", "type": "text/plain" }, "key": "name", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f91cdff3-7ff1-43fc-85bd-3d049c465450", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "smartCampaign", "byName.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Name for the smart campaign", "type": "text/plain" }, "key": "name", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"batch\",\n \"isSystem\": \"\",\n \"isActive\": \"\",\n \"isRequestable\": \"\",\n \"recurrence\": {\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"intervalType\": \"Monthly\",\n \"interval\": \"\",\n \"weekdayOnly\": \"\",\n \"weekdayMask\": [\n \"\",\n \"\"\n ],\n \"dayOfMonth\": \"\",\n \"dayOfWeek\": \"Monday\",\n \"weekOfMonth\": \"\"\n },\n \"qualificationRuleType\": \"interval\",\n \"qualificationRuleInterval\": \"\",\n \"qualificationRuleUnit\": \"month\",\n \"maxMembers\": \"\",\n \"isCommunicationLimitEnabled\": \"\",\n \"smartListId\": \"\",\n \"flowId\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"workspace\": \"\",\n \"status\": \"Single Run\",\n \"parentProgramId\": \"\",\n \"computedUrl\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"trigger\",\n \"isSystem\": \"\",\n \"isActive\": \"\",\n \"isRequestable\": \"\",\n \"recurrence\": {\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"intervalType\": \"Monthly\",\n \"interval\": \"\",\n \"weekdayOnly\": \"\",\n \"weekdayMask\": [\n \"\",\n \"\"\n ],\n \"dayOfMonth\": \"\",\n \"dayOfWeek\": \"Wednesday\",\n \"weekOfMonth\": \"\"\n },\n \"qualificationRuleType\": \"any\",\n \"qualificationRuleInterval\": \"\",\n \"qualificationRuleUnit\": \"week\",\n \"maxMembers\": \"\",\n \"isCommunicationLimitEnabled\": \"\",\n \"smartListId\": \"\",\n \"flowId\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"workspace\": \"\",\n \"status\": \"Requested\",\n \"parentProgramId\": \"\",\n \"computedUrl\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e92db940-2f4b-4dda-a9fa-369e14098d64", "name": "Get Smart Campaign by Id", "request": { "name": "Get Smart Campaign by Id", "description": { "content": "Returns the smart campaign for the given id. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "smartCampaign", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d147fac4-3e71-4401-b21d-cbc9fe7db518", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "smartCampaign", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"batch\",\n \"isSystem\": \"\",\n \"isActive\": \"\",\n \"isRequestable\": \"\",\n \"recurrence\": {\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"intervalType\": \"Monthly\",\n \"interval\": \"\",\n \"weekdayOnly\": \"\",\n \"weekdayMask\": [\n \"\",\n \"\"\n ],\n \"dayOfMonth\": \"\",\n \"dayOfWeek\": \"Monday\",\n \"weekOfMonth\": \"\"\n },\n \"qualificationRuleType\": \"interval\",\n \"qualificationRuleInterval\": \"\",\n \"qualificationRuleUnit\": \"month\",\n \"maxMembers\": \"\",\n \"isCommunicationLimitEnabled\": \"\",\n \"smartListId\": \"\",\n \"flowId\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"workspace\": \"\",\n \"status\": \"Single Run\",\n \"parentProgramId\": \"\",\n \"computedUrl\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"trigger\",\n \"isSystem\": \"\",\n \"isActive\": \"\",\n \"isRequestable\": \"\",\n \"recurrence\": {\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"intervalType\": \"Monthly\",\n \"interval\": \"\",\n \"weekdayOnly\": \"\",\n \"weekdayMask\": [\n \"\",\n \"\"\n ],\n \"dayOfMonth\": \"\",\n \"dayOfWeek\": \"Wednesday\",\n \"weekOfMonth\": \"\"\n },\n \"qualificationRuleType\": \"any\",\n \"qualificationRuleInterval\": \"\",\n \"qualificationRuleUnit\": \"week\",\n \"maxMembers\": \"\",\n \"isCommunicationLimitEnabled\": \"\",\n \"smartListId\": \"\",\n \"flowId\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"workspace\": \"\",\n \"status\": \"Requested\",\n \"parentProgramId\": \"\",\n \"computedUrl\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "41b6d105-c246-4c83-96ba-66e1f05a3b7c", "name": "Update Smart Campaign", "request": { "name": "Update Smart Campaign", "description": { "content": "Update the smart campaign for the given id. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "smartCampaign", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a0c45da7-901a-4721-ab12-1e462f442145", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "smartCampaign", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"batch\",\n \"isSystem\": \"\",\n \"isActive\": \"\",\n \"isRequestable\": \"\",\n \"recurrence\": {\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"intervalType\": \"Monthly\",\n \"interval\": \"\",\n \"weekdayOnly\": \"\",\n \"weekdayMask\": [\n \"\",\n \"\"\n ],\n \"dayOfMonth\": \"\",\n \"dayOfWeek\": \"Monday\",\n \"weekOfMonth\": \"\"\n },\n \"qualificationRuleType\": \"interval\",\n \"qualificationRuleInterval\": \"\",\n \"qualificationRuleUnit\": \"month\",\n \"maxMembers\": \"\",\n \"isCommunicationLimitEnabled\": \"\",\n \"smartListId\": \"\",\n \"flowId\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"workspace\": \"\",\n \"status\": \"Single Run\",\n \"parentProgramId\": \"\",\n \"computedUrl\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"trigger\",\n \"isSystem\": \"\",\n \"isActive\": \"\",\n \"isRequestable\": \"\",\n \"recurrence\": {\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"intervalType\": \"Monthly\",\n \"interval\": \"\",\n \"weekdayOnly\": \"\",\n \"weekdayMask\": [\n \"\",\n \"\"\n ],\n \"dayOfMonth\": \"\",\n \"dayOfWeek\": \"Wednesday\",\n \"weekOfMonth\": \"\"\n },\n \"qualificationRuleType\": \"any\",\n \"qualificationRuleInterval\": \"\",\n \"qualificationRuleUnit\": \"week\",\n \"maxMembers\": \"\",\n \"isCommunicationLimitEnabled\": \"\",\n \"smartListId\": \"\",\n \"flowId\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"workspace\": \"\",\n \"status\": \"Requested\",\n \"parentProgramId\": \"\",\n \"computedUrl\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b94bde11-7c76-493f-bb49-50f03ec5ea7a", "name": "Activate Smart Campaign", "request": { "name": "Activate Smart Campaign", "description": { "content": "Activates a trigger smart campaign. Required Permissions: Activate Campaign", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "smartCampaign", ":id", "activate.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Id of the smart campaign", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "8157db58-7c41-4b08-8752-b4ba9da9e1f3", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "smartCampaign", ":id", "activate.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the smart campaign", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ecc068de-cf36-4047-9714-5379863bd6b6", "name": "Clone Smart Campaign", "request": { "name": "Clone Smart Campaign", "description": { "content": "Clones a smart campaign. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "smartCampaign", ":id", "clone.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Id of the smart campaign", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "type", "value": "Program" }, { "disabled": false, "description": { "content": "(Required) Name of the smart campaign", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Description of the smart campaign", "type": "text/plain" }, "key": "description", "value": "" } ] }, "auth": null }, "response": [ { "id": "c328d335-9ce2-4c5c-9321-31dcc54e0c7e", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "smartCampaign", ":id", "clone.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the smart campaign", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "type", "value": "Program" }, { "disabled": false, "description": { "content": "(Required) Name of the smart campaign", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Description of the smart campaign", "type": "text/plain" }, "key": "description", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"batch\",\n \"isSystem\": \"\",\n \"isActive\": \"\",\n \"isRequestable\": \"\",\n \"recurrence\": {\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"intervalType\": \"Monthly\",\n \"interval\": \"\",\n \"weekdayOnly\": \"\",\n \"weekdayMask\": [\n \"\",\n \"\"\n ],\n \"dayOfMonth\": \"\",\n \"dayOfWeek\": \"Monday\",\n \"weekOfMonth\": \"\"\n },\n \"qualificationRuleType\": \"interval\",\n \"qualificationRuleInterval\": \"\",\n \"qualificationRuleUnit\": \"month\",\n \"maxMembers\": \"\",\n \"isCommunicationLimitEnabled\": \"\",\n \"smartListId\": \"\",\n \"flowId\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"workspace\": \"\",\n \"status\": \"Single Run\",\n \"parentProgramId\": \"\",\n \"computedUrl\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"trigger\",\n \"isSystem\": \"\",\n \"isActive\": \"\",\n \"isRequestable\": \"\",\n \"recurrence\": {\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"intervalType\": \"Monthly\",\n \"interval\": \"\",\n \"weekdayOnly\": \"\",\n \"weekdayMask\": [\n \"\",\n \"\"\n ],\n \"dayOfMonth\": \"\",\n \"dayOfWeek\": \"Wednesday\",\n \"weekOfMonth\": \"\"\n },\n \"qualificationRuleType\": \"any\",\n \"qualificationRuleInterval\": \"\",\n \"qualificationRuleUnit\": \"week\",\n \"maxMembers\": \"\",\n \"isCommunicationLimitEnabled\": \"\",\n \"smartListId\": \"\",\n \"flowId\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"workspace\": \"\",\n \"status\": \"Requested\",\n \"parentProgramId\": \"\",\n \"computedUrl\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2da39793-b23d-4a08-9903-f8eec7385924", "name": "Deactivate Smart Campaign", "request": { "name": "Deactivate Smart Campaign", "description": { "content": "Deactivates a trigger smart campaign. Required Permissions: Deactivate Campaign", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "smartCampaign", ":id", "deactivate.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Id of the smart campaign", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "680337aa-6a18-46c0-b4c0-4b30d2d74735", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "smartCampaign", ":id", "deactivate.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the smart campaign", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0560866b-84fb-491f-805a-2852f7c0c564", "name": "Delete Smart Campaign", "request": { "name": "Delete Smart Campaign", "description": { "content": "Deletes a smart campaign. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "smartCampaign", ":id", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Id of the smart campaign", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "09c21ba1-28d0-4aca-bce9-cad0cd13692d", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "smartCampaign", ":id", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the smart campaign", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c340ff83-7d14-45a7-99da-61abdce1915d", "name": "Get Smart List by Smart Campaign Id", "request": { "name": "Get Smart List by Smart Campaign Id", "description": { "content": "Retrieves a Smart List record by its Smart Campaign id. Required Permissions: Read-Asset or Read-Write Asset", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "smartCampaign", ":id", "smartList.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Set true to populate smart list rules. Default false", "type": "text/plain" }, "key": "includeRules", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Id for the smart campaign containing smart list to retrieve", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4d43e4ea-5410-4970-b4f9-4aed787fec7c", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "smartCampaign", ":id", "smartList.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Set true to populate smart list rules. Default false", "type": "text/plain" }, "key": "includeRules", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Id for the smart campaign containing smart list to retrieve", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"workspace\": \"\",\n \"rules\": {\n \"filterMatchType\": \"Any\",\n \"triggers\": [\n \"\",\n \"\"\n ],\n \"filters\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"ruleTypeId\": \"\",\n \"ruleType\": \"\",\n \"operator\": \"\",\n \"conditions\": [\n {\n \"activityAttributeId\": \"\",\n \"activityAttributeName\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"isPrimary\": \"\"\n },\n {\n \"activityAttributeId\": \"\",\n \"activityAttributeName\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"isPrimary\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"ruleTypeId\": \"\",\n \"ruleType\": \"\",\n \"operator\": \"\",\n \"conditions\": [\n {\n \"activityAttributeId\": \"\",\n \"activityAttributeName\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"isPrimary\": \"\"\n },\n {\n \"activityAttributeId\": \"\",\n \"activityAttributeName\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"isPrimary\": \"\"\n }\n ]\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"workspace\": \"\",\n \"rules\": {\n \"filterMatchType\": \"Advanced\",\n \"triggers\": [\n \"\",\n \"\"\n ],\n \"filters\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"ruleTypeId\": \"\",\n \"ruleType\": \"\",\n \"operator\": \"\",\n \"conditions\": [\n {\n \"activityAttributeId\": \"\",\n \"activityAttributeName\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"isPrimary\": \"\"\n },\n {\n \"activityAttributeId\": \"\",\n \"activityAttributeName\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"isPrimary\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"ruleTypeId\": \"\",\n \"ruleType\": \"\",\n \"operator\": \"\",\n \"conditions\": [\n {\n \"activityAttributeId\": \"\",\n \"activityAttributeName\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"isPrimary\": \"\"\n },\n {\n \"activityAttributeId\": \"\",\n \"activityAttributeName\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"isPrimary\": \"\"\n }\n ]\n }\n ]\n }\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ff3eb5b7-2743-43aa-ba8d-2d61b4eec9ae", "name": "Get Smart Campaigns", "request": { "name": "Get Smart Campaigns", "description": { "content": "Retrieves all smart campaigns. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "smartCampaigns.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of smart campaigns to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "folder", "value": "" }, { "disabled": true, "description": { "content": "Exclude smart campaigns prior to this date. Must be valid ISO-8601 string. See Datetime field type description.", "type": "text/plain" }, "key": "earliestUpdatedAt", "value": "" }, { "disabled": true, "description": { "content": "Exclude smart campaigns after this date. Must be valid ISO-8601 string. See Datetime field type description.", "type": "text/plain" }, "key": "latestUpdatedAt", "value": "" }, { "disabled": true, "description": { "content": "Set true to return only active campaigns. Default false", "type": "text/plain" }, "key": "isActive", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "88d16ae2-c4fd-44cb-b93b-fac1f8bae61f", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "smartCampaigns.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of smart campaigns to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "folder", "value": "" }, { "disabled": true, "description": { "content": "Exclude smart campaigns prior to this date. Must be valid ISO-8601 string. See Datetime field type description.", "type": "text/plain" }, "key": "earliestUpdatedAt", "value": "" }, { "disabled": true, "description": { "content": "Exclude smart campaigns after this date. Must be valid ISO-8601 string. See Datetime field type description.", "type": "text/plain" }, "key": "latestUpdatedAt", "value": "" }, { "disabled": true, "description": { "content": "Set true to return only active campaigns. Default false", "type": "text/plain" }, "key": "isActive", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"batch\",\n \"isSystem\": \"\",\n \"isActive\": \"\",\n \"isRequestable\": \"\",\n \"recurrence\": {\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"intervalType\": \"Monthly\",\n \"interval\": \"\",\n \"weekdayOnly\": \"\",\n \"weekdayMask\": [\n \"\",\n \"\"\n ],\n \"dayOfMonth\": \"\",\n \"dayOfWeek\": \"Monday\",\n \"weekOfMonth\": \"\"\n },\n \"qualificationRuleType\": \"interval\",\n \"qualificationRuleInterval\": \"\",\n \"qualificationRuleUnit\": \"month\",\n \"maxMembers\": \"\",\n \"isCommunicationLimitEnabled\": \"\",\n \"smartListId\": \"\",\n \"flowId\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"workspace\": \"\",\n \"status\": \"Single Run\",\n \"parentProgramId\": \"\",\n \"computedUrl\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"trigger\",\n \"isSystem\": \"\",\n \"isActive\": \"\",\n \"isRequestable\": \"\",\n \"recurrence\": {\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"intervalType\": \"Monthly\",\n \"interval\": \"\",\n \"weekdayOnly\": \"\",\n \"weekdayMask\": [\n \"\",\n \"\"\n ],\n \"dayOfMonth\": \"\",\n \"dayOfWeek\": \"Wednesday\",\n \"weekOfMonth\": \"\"\n },\n \"qualificationRuleType\": \"any\",\n \"qualificationRuleInterval\": \"\",\n \"qualificationRuleUnit\": \"week\",\n \"maxMembers\": \"\",\n \"isCommunicationLimitEnabled\": \"\",\n \"smartListId\": \"\",\n \"flowId\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"workspace\": \"\",\n \"status\": \"Requested\",\n \"parentProgramId\": \"\",\n \"computedUrl\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "301eff68-35cb-4e1d-b90a-ca25d438ca0c", "name": "Create Smart Campaign", "request": { "name": "Create Smart Campaign", "description": { "content": "Creates a new smart campaign. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "smartCampaigns.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "type", "value": "Program" }, { "disabled": false, "description": { "content": "(Required) Name of the smart campaign", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Description of the smart campaign", "type": "text/plain" }, "key": "description", "value": "" } ] }, "auth": null }, "response": [ { "id": "ad705fb0-ef23-4282-8947-46437ac82002", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "smartCampaigns.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "type", "value": "Program" }, { "disabled": false, "description": { "content": "(Required) Name of the smart campaign", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Description of the smart campaign", "type": "text/plain" }, "key": "description", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"batch\",\n \"isSystem\": \"\",\n \"isActive\": \"\",\n \"isRequestable\": \"\",\n \"recurrence\": {\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"intervalType\": \"Monthly\",\n \"interval\": \"\",\n \"weekdayOnly\": \"\",\n \"weekdayMask\": [\n \"\",\n \"\"\n ],\n \"dayOfMonth\": \"\",\n \"dayOfWeek\": \"Monday\",\n \"weekOfMonth\": \"\"\n },\n \"qualificationRuleType\": \"interval\",\n \"qualificationRuleInterval\": \"\",\n \"qualificationRuleUnit\": \"month\",\n \"maxMembers\": \"\",\n \"isCommunicationLimitEnabled\": \"\",\n \"smartListId\": \"\",\n \"flowId\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"workspace\": \"\",\n \"status\": \"Single Run\",\n \"parentProgramId\": \"\",\n \"computedUrl\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"trigger\",\n \"isSystem\": \"\",\n \"isActive\": \"\",\n \"isRequestable\": \"\",\n \"recurrence\": {\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"intervalType\": \"Monthly\",\n \"interval\": \"\",\n \"weekdayOnly\": \"\",\n \"weekdayMask\": [\n \"\",\n \"\"\n ],\n \"dayOfMonth\": \"\",\n \"dayOfWeek\": \"Wednesday\",\n \"weekOfMonth\": \"\"\n },\n \"qualificationRuleType\": \"any\",\n \"qualificationRuleInterval\": \"\",\n \"qualificationRuleUnit\": \"week\",\n \"maxMembers\": \"\",\n \"isCommunicationLimitEnabled\": \"\",\n \"smartListId\": \"\",\n \"flowId\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"workspace\": \"\",\n \"status\": \"Requested\",\n \"parentProgramId\": \"\",\n \"computedUrl\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Smart Lists", "description": "Read Smart Lists and their filter/rule definitions.", "item": [ { "id": "cc75acb8-dc62-4c61-841c-daa43965cf1f", "name": "Get Smart List by Name", "request": { "name": "Get Smart List by Name", "description": { "content": "Retrieves a Smart List record by its name. Required Permissions: Read-Asset or Read-Write Asset", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "smartList", "byName.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Name of smart list to retrieve", "type": "text/plain" }, "key": "name", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ce198ef9-13f3-46b2-84db-fc4469a64dd4", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "smartList", "byName.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Name of smart list to retrieve", "type": "text/plain" }, "key": "name", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"workspace\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "670d8152-0763-4bea-b795-d35312037f23", "name": "Get Smart List by Id", "request": { "name": "Get Smart List by Id", "description": { "content": "Retrieves a Smart List record by its id. Required Permissions: Read-Asset or Read-Write Asset", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "smartList", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Set true to populate smart list rules. Default false", "type": "text/plain" }, "key": "includeRules", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "7b71d3be-81de-4cef-af97-84b31ef23ed8", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "smartList", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Set true to populate smart list rules. Default false", "type": "text/plain" }, "key": "includeRules", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"workspace\": \"\",\n \"rules\": {\n \"filterMatchType\": \"Any\",\n \"triggers\": [\n \"\",\n \"\"\n ],\n \"filters\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"ruleTypeId\": \"\",\n \"ruleType\": \"\",\n \"operator\": \"\",\n \"conditions\": [\n {\n \"activityAttributeId\": \"\",\n \"activityAttributeName\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"isPrimary\": \"\"\n },\n {\n \"activityAttributeId\": \"\",\n \"activityAttributeName\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"isPrimary\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"ruleTypeId\": \"\",\n \"ruleType\": \"\",\n \"operator\": \"\",\n \"conditions\": [\n {\n \"activityAttributeId\": \"\",\n \"activityAttributeName\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"isPrimary\": \"\"\n },\n {\n \"activityAttributeId\": \"\",\n \"activityAttributeName\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"isPrimary\": \"\"\n }\n ]\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"workspace\": \"\",\n \"rules\": {\n \"filterMatchType\": \"Advanced\",\n \"triggers\": [\n \"\",\n \"\"\n ],\n \"filters\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"ruleTypeId\": \"\",\n \"ruleType\": \"\",\n \"operator\": \"\",\n \"conditions\": [\n {\n \"activityAttributeId\": \"\",\n \"activityAttributeName\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"isPrimary\": \"\"\n },\n {\n \"activityAttributeId\": \"\",\n \"activityAttributeName\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"isPrimary\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"ruleTypeId\": \"\",\n \"ruleType\": \"\",\n \"operator\": \"\",\n \"conditions\": [\n {\n \"activityAttributeId\": \"\",\n \"activityAttributeName\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"isPrimary\": \"\"\n },\n {\n \"activityAttributeId\": \"\",\n \"activityAttributeName\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"isPrimary\": \"\"\n }\n ]\n }\n ]\n }\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "62e328f5-8cc5-4388-b1a4-634e94b78f84", "name": "Clone Smart List", "request": { "name": "Clone Smart List", "description": { "content": "Clones the designated Smart List. Required Permissions: Read-Write Asset", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "smartList", ":id", "clone.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Id of smart list to clone", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Name for the cloned smart list", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "type", "value": "Program" }, { "disabled": true, "description": { "content": "Description of the cloned smart list", "type": "text/plain" }, "key": "description", "value": "" } ] }, "auth": null }, "response": [ { "id": "e635255a-2e6b-4d1f-b36e-8dfc5401d2cf", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "smartList", ":id", "clone.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of smart list to clone", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Name for the cloned smart list", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "type", "value": "Program" }, { "disabled": true, "description": { "content": "Description of the cloned smart list", "type": "text/plain" }, "key": "description", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"workspace\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "56a75661-7b0c-463e-8d65-b9bccdeb749e", "name": "Delete Smart List", "request": { "name": "Delete Smart List", "description": { "content": "Deletes the designated Smart List. Required Permissions: Read-Write Asset", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "smartList", ":id", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Id of the smart list to delete", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "460db742-7f09-4e69-9968-c7a034f17b0f", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "smartList", ":id", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the smart list to delete", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1bbdcc5d-1463-4d46-b39b-f00d9438f1bd", "name": "Get Smart Lists", "request": { "name": "Get Smart Lists", "description": { "content": "Retrieves a list of user created Smart List records. Required Permissions: Read-Asset or Read-Write Asset", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "smartLists.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "folder", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of smart lists to return. Max 200, default 20.", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Exclude smart lists prior to this date. Must be valid ISO-8601 string. See Datetime field type description.", "type": "text/plain" }, "key": "earliestUpdatedAt", "value": "" }, { "disabled": true, "description": { "content": "Exclude smart lists after this date. Must be valid ISO-8601 string. See Datetime field type description.", "type": "text/plain" }, "key": "latestUpdatedAt", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c975364c-217d-42cc-9d1f-f96f1e982949", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "smartLists.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "folder", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of smart lists to return. Max 200, default 20.", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Exclude smart lists prior to this date. Must be valid ISO-8601 string. See Datetime field type description.", "type": "text/plain" }, "key": "earliestUpdatedAt", "value": "" }, { "disabled": true, "description": { "content": "Exclude smart lists after this date. Must be valid ISO-8601 string. See Datetime field type description.", "type": "text/plain" }, "key": "latestUpdatedAt", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Folder\"\n },\n \"workspace\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Snippets", "description": "CRUD operations on snippets, including content, dynamic content, and approval.", "item": [ { "id": "9a0a0ea3-12d6-46bf-af09-d242fcb9406a", "name": "Get Snippet by Id", "request": { "name": "Get Snippet by Id", "description": { "content": "Retrieves the target snippet record. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "snippet", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a2ebb37a-3ac2-4e92-91c0-7acd7dc51628", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "snippet", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"folder\": {\n \"value\": \"\",\n \"type\": \"Program\",\n \"folderName\": \"\"\n },\n \"status\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n },\n {\n \"folder\": {\n \"value\": \"\",\n \"type\": \"Folder\",\n \"folderName\": \"\"\n },\n \"status\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8ed012f2-119f-4181-a156-ee84a9057199", "name": "Update Snippet Metadata", "request": { "name": "Update Snippet Metadata", "description": { "content": "Updates the metadata of the snippet. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "snippet", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "Description of the snippet", "type": "text/plain" }, "key": "description", "value": "" }, { "disabled": true, "description": { "content": "Archival status of the snippet", "type": "text/plain" }, "key": "isArchive", "value": "" }, { "disabled": true, "description": { "content": "Name of the snippet", "type": "text/plain" }, "key": "name", "value": "" } ] }, "auth": null }, "response": [ { "id": "2ced7cd6-6cae-4e7a-bb3c-942b412a09e0", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "snippet", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "Description of the snippet", "type": "text/plain" }, "key": "description", "value": "" }, { "disabled": true, "description": { "content": "Archival status of the snippet", "type": "text/plain" }, "key": "isArchive", "value": "" }, { "disabled": true, "description": { "content": "Name of the snippet", "type": "text/plain" }, "key": "name", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"folder\": {\n \"value\": \"\",\n \"type\": \"Program\",\n \"folderName\": \"\"\n },\n \"status\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n },\n {\n \"folder\": {\n \"value\": \"\",\n \"type\": \"Folder\",\n \"folderName\": \"\"\n },\n \"status\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7d64faa0-843e-470c-aef8-f30b7b9fc660", "name": "Approve Snippet Draft", "request": { "name": "Approve Snippet Draft", "description": { "content": "Approves the current draft of the snippet. Required Permissions: Approve Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "snippet", ":id", "approveDraft.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "c80ed262-bbb5-4c79-8fb8-51a2bedd0091", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "snippet", ":id", "approveDraft.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"folder\": {\n \"value\": \"\",\n \"type\": \"Program\",\n \"folderName\": \"\"\n },\n \"status\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n },\n {\n \"folder\": {\n \"value\": \"\",\n \"type\": \"Folder\",\n \"folderName\": \"\"\n },\n \"status\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b9e06db3-cb1c-4bb1-a5a8-402dc045529d", "name": "Clone Snippet", "request": { "name": "Clone Snippet", "description": { "content": "Clones the target snippet. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "snippet", ":id", "clone.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Name for the cloned snippet", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "type", "value": "Program" }, { "disabled": true, "description": { "content": "Description of the cloned snippet", "type": "text/plain" }, "key": "description", "value": "" } ] }, "auth": null }, "response": [ { "id": "cedd385d-0303-45a4-a888-63709afe5113", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "snippet", ":id", "clone.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Name for the cloned snippet", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "type", "value": "Program" }, { "disabled": true, "description": { "content": "Description of the cloned snippet", "type": "text/plain" }, "key": "description", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"folder\": {\n \"value\": \"\",\n \"type\": \"Program\",\n \"folderName\": \"\"\n },\n \"status\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n },\n {\n \"folder\": {\n \"value\": \"\",\n \"type\": \"Folder\",\n \"folderName\": \"\"\n },\n \"status\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f7bd0832-ee91-4320-b786-d601fa2ce0fe", "name": "Get Snippet Content", "request": { "name": "Get Snippet Content", "description": { "content": "Retrieves the content of the target snippet. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "snippet", ":id", "content.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "13c74b4e-47f0-4079-9c5c-e64c62e258cc", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "snippet", ":id", "content.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"type\": \"\",\n \"content\": \"\"\n },\n {\n \"type\": \"\",\n \"content\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "99157e5b-883a-4395-819e-a58d52ac95de", "name": "Update Snippet Content", "request": { "name": "Update Snippet Content", "description": { "content": "Updates the content of the target snippet. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "snippet", ":id", "content.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Content of the snippet", "type": "text/plain" }, "key": "content", "value": "" }, { "disabled": false, "description": { "content": "(Required) Type of snippet content (This can only be one of DynamicContent,HTML,Text)", "type": "text/plain" }, "key": "type", "value": "DynamicContent" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "953190ad-f44e-4e61-be99-dab3746ce368", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "snippet", ":id", "content.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Content of the snippet", "type": "text/plain" }, "key": "content", "value": "" }, { "disabled": false, "description": { "content": "(Required) Type of snippet content (This can only be one of DynamicContent,HTML,Text)", "type": "text/plain" }, "key": "type", "value": "DynamicContent" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f266e250-386b-4775-8fa8-874393758829", "name": "Delete Snippet", "request": { "name": "Delete Snippet", "description": { "content": "Deletes the target snippet. The snippet may not be in use by emails or landing pages. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "snippet", ":id", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "630e88cb-d505-4510-9c06-bcdffbf0c7f2", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "snippet", ":id", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "feaf9049-95e8-485c-9968-a4714ed2e297", "name": "Discard Snippet Draft", "request": { "name": "Discard Snippet Draft", "description": { "content": "Discards the current draft of the snippet. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "snippet", ":id", "discardDraft.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "b9413b8b-6efd-43e7-8313-7dbe1413de09", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "snippet", ":id", "discardDraft.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "01126ea9-ed0e-4d26-a3f8-8783c99b8733", "name": "Get Dynamic Content", "request": { "name": "Get Dynamic Content", "description": { "content": "Gets the list of dynamic content sections for the snippet. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "snippet", ":id", "dynamicContent.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "66e5264c-de67-41b0-b7d7-7cb062d85e8b", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "snippet", ":id", "dynamicContent.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1d5b828a-2cca-47ee-8146-89d1295dca5e", "name": "Update Snippet Dynamic Content", "request": { "name": "Update Snippet Dynamic Content", "description": { "content": "Updates the target dynamic content section. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "snippet", ":id", "dynamicContent", "{{segmentId}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "Type of dynamic content section", "type": "text/plain" }, "key": "type", "value": "Typeofcontent.Either'HTML'or'Text'" }, { "disabled": true, "description": { "content": "Value of the dynamic content section", "type": "text/plain" }, "key": "value", "value": "" } ] }, "auth": null }, "response": [ { "id": "7225b7af-f6a6-4046-afbe-bc0cfa280dd0", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "snippet", ":id", "dynamicContent", "{{segmentId}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "Type of dynamic content section", "type": "text/plain" }, "key": "type", "value": "Typeofcontent.Either'HTML'or'Text'" }, { "disabled": true, "description": { "content": "Value of the dynamic content section", "type": "text/plain" }, "key": "value", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9c090fbc-3f51-44aa-9e67-16ea987038fa", "name": "Unapprove Snippet", "request": { "name": "Unapprove Snippet", "description": { "content": "Unapproves the current version of the snippet. The snippet may not be in use. The snippet will be reverted to a draft-only state. Required Permissions: Approve Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "snippet", ":id", "unapprove.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "d3e560b7-8907-4692-af2d-c632fc34a52b", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "snippet", ":id", "unapprove.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"folder\": {\n \"value\": \"\",\n \"type\": \"Program\",\n \"folderName\": \"\"\n },\n \"status\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n },\n {\n \"folder\": {\n \"value\": \"\",\n \"type\": \"Folder\",\n \"folderName\": \"\"\n },\n \"status\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1a81b7d0-eb44-48c2-9642-3e9e2288ed73", "name": "Get Snippets", "request": { "name": "Get Snippets", "description": { "content": "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 endpoint.", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "snippets.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" }, { "disabled": true, "description": { "content": "Maximum number of records to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "fef77a40-00ed-4049-911a-f35eeb3a3603", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "snippets.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" }, { "disabled": true, "description": { "content": "Maximum number of records to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"folder\": {\n \"value\": \"\",\n \"type\": \"Program\",\n \"folderName\": \"\"\n },\n \"status\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n },\n {\n \"folder\": {\n \"value\": \"\",\n \"type\": \"Folder\",\n \"folderName\": \"\"\n },\n \"status\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c76682a3-ca1b-4e08-975b-2a3d95f5a4cc", "name": "Create Snippet", "request": { "name": "Create Snippet", "description": { "content": "Creates a new snippet. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "snippets.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "type", "value": "Program" }, { "disabled": false, "description": { "content": "(Required) Name of the snippet", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Description of the snippet", "type": "text/plain" }, "key": "description", "value": "" } ] }, "auth": null }, "response": [ { "id": "f80a5083-e350-4fff-9db2-19784c2489dd", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "snippets.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "(Required) JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'", "type": "text/plain" }, "key": "type", "value": "Program" }, { "disabled": false, "description": { "content": "(Required) Name of the snippet", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Description of the snippet", "type": "text/plain" }, "key": "description", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"folder\": {\n \"value\": \"\",\n \"type\": \"Program\",\n \"folderName\": \"\"\n },\n \"status\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n },\n {\n \"folder\": {\n \"value\": \"\",\n \"type\": \"Folder\",\n \"folderName\": \"\"\n },\n \"status\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Segments", "description": "Read segmentations and the segments they contain, used for dynamic content.", "item": [ { "id": "a3597d7d-92f7-4dac-a5d6-d5b110d67773", "name": "Get Segmentations", "request": { "name": "Get Segmentations", "description": { "content": "Retrieves a list of accessible segmentations for the target instance. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "segmentation.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "dce977cf-e94b-4665-813e-14567574bdfe", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "segmentation.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"status\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n },\n {\n \"folder\": {\n \"id\": \"\",\n \"type\": \"Program\"\n },\n \"status\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\",\n \"workspace\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aa41d0e7-32b6-42e2-8cf8-2476b7e7f292", "name": "Get Segments For Segmentation", "request": { "name": "Get Segments For Segmentation", "description": { "content": "Retrieves a list of segments inside the target segmentation. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "segmentation", ":id", "segments.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of records to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "69b7aee8-01da-4f0e-b897-22a1e85de7e8", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "segmentation", ":id", "segments.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Status filter for draft or approved versions (This can only be one of approved,draft)", "type": "text/plain" }, "key": "status", "value": "draft" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of records to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"segmentationId\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\"\n },\n {\n \"segmentationId\": \"\",\n \"createdAt\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"url\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Tags", "description": "Read program tag types and their allowed values.", "item": [ { "id": "b62ba0f7-7ae6-4144-a044-a6df8ede0222", "name": "Get Tag By Name", "request": { "name": "Get Tag By Name", "description": { "content": "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", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "tagType", "byName.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Name of the tag", "type": "text/plain" }, "key": "name", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c4efaf5d-2d2d-463f-beb6-e08e4e169310", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "tagType", "byName.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Name of the tag", "type": "text/plain" }, "key": "name", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"applicableProgramTypes\": \"\",\n \"required\": \"\",\n \"tagType\": \"\",\n \"allowableValues\": \"\"\n },\n {\n \"applicableProgramTypes\": \"\",\n \"required\": \"\",\n \"tagType\": \"\",\n \"allowableValues\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4dd5a64e-533a-4ba3-b095-3c14de4499f3", "name": "Get Tag Types", "request": { "name": "Get Tag Types", "description": { "content": "Retrieves a list of available tag types. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "tagTypes.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of records to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c6ba3645-626a-48a9-ae74-f3abbc2a5fca", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "tagTypes.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of records to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"applicableProgramTypes\": \"\",\n \"required\": \"\",\n \"tagType\": \"\"\n },\n {\n \"applicableProgramTypes\": \"\",\n \"required\": \"\",\n \"tagType\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Channels", "description": "Read program channels and the progression statuses they define.", "item": [ { "id": "94da54b8-744f-476e-9199-b5e66e57867f", "name": "Get Channel by Name", "request": { "name": "Get Channel by Name", "description": { "content": "Retrieves channels based on the provided name. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "channel", "byName.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Name of channel to retrieve", "type": "text/plain" }, "key": "Name", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "975262a7-9a50-40da-bd80-c805cc2e48e2", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "channel", "byName.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Name of channel to retrieve", "type": "text/plain" }, "key": "Name", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"applicableProgramType\": \"\",\n \"createdAt\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"progressionStatuses\": [\n {\n \"description\": \"\",\n \"hidden\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"step\": \"\",\n \"success\": \"\"\n },\n {\n \"description\": \"\",\n \"hidden\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"step\": \"\",\n \"success\": \"\"\n }\n ]\n },\n {\n \"applicableProgramType\": \"\",\n \"createdAt\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"progressionStatuses\": [\n {\n \"description\": \"\",\n \"hidden\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"step\": \"\",\n \"success\": \"\"\n },\n {\n \"description\": \"\",\n \"hidden\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"step\": \"\",\n \"success\": \"\"\n }\n ]\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f67eec3b-ea5e-4ea2-842c-810410033604", "name": "Get Channels", "request": { "name": "Get Channels", "description": { "content": "Retrieves all channels. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "channels.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of records to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0c1c64e9-222c-4b74-873f-a34363627598", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "channels.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of records to return. Max 200, default 20", "type": "text/plain" }, "key": "maxReturn", "value": "" }, { "disabled": true, "description": { "content": "Integer offset for paging", "type": "text/plain" }, "key": "offset", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"applicableProgramType\": \"\",\n \"createdAt\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"progressionStatuses\": [\n {\n \"description\": \"\",\n \"hidden\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"step\": \"\",\n \"success\": \"\"\n },\n {\n \"description\": \"\",\n \"hidden\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"step\": \"\",\n \"success\": \"\"\n }\n ]\n },\n {\n \"applicableProgramType\": \"\",\n \"createdAt\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updatedAt\": \"\",\n \"progressionStatuses\": [\n {\n \"description\": \"\",\n \"hidden\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"step\": \"\",\n \"success\": \"\"\n },\n {\n \"description\": \"\",\n \"hidden\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"step\": \"\",\n \"success\": \"\"\n }\n ]\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Tokens", "description": "Create, read, and delete My Tokens on folders and programs.", "item": [ { "id": "5e96d02e-14e4-42d4-904d-873b0923a9ca", "name": "Get Tokens by Folder Id", "request": { "name": "Get Tokens by Folder Id", "description": { "content": "Retrieves the list of available My Tokens in the target folder. Required Permissions: Read-Only Assets, Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "folder", ":id", "tokens.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Type of folder. 'Folder' or 'Program' (This can only be one of Folder,Program)", "type": "text/plain" }, "key": "folderType", "value": "Folder" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ac9c30b5-e174-4ea0-ac77-c2051b25d139", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "folder", ":id", "tokens.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Type of folder. 'Folder' or 'Program' (This can only be one of Folder,Program)", "type": "text/plain" }, "key": "folderType", "value": "Folder" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"folder\": \"\",\n \"tokens\": [\n {\n \"computedUrl\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"computedUrl\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"folder\": \"\",\n \"tokens\": [\n {\n \"computedUrl\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"computedUrl\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2ea05c47-c370-4272-ac04-dac8b27bc8f8", "name": "Create Token", "request": { "name": "Create Token", "description": { "content": "Create or update a token in the parent folder. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "folder", ":id", "tokens.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Id of the folder to which the token will be associated with", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Type of folder. 'Folder' or 'Program'", "type": "text/plain" }, "key": "folderType", "value": "Program" }, { "disabled": false, "description": { "content": "(Required) Name of the token. Max length is 50 characters)", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": false, "description": { "content": "(Required) Type of the token", "type": "text/plain" }, "key": "type", "value": "date" }, { "disabled": false, "description": { "content": "(Required) Value of the token", "type": "text/plain" }, "key": "value", "value": "" } ] }, "auth": null }, "response": [ { "id": "52449e4d-ec16-4b43-aa18-901098926737", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "folder", ":id", "tokens.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the folder to which the token will be associated with", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Type of folder. 'Folder' or 'Program'", "type": "text/plain" }, "key": "folderType", "value": "Program" }, { "disabled": false, "description": { "content": "(Required) Name of the token. Max length is 50 characters)", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": false, "description": { "content": "(Required) Type of the token", "type": "text/plain" }, "key": "type", "value": "date" }, { "disabled": false, "description": { "content": "(Required) Value of the token", "type": "text/plain" }, "key": "value", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"folder\": \"\",\n \"tokens\": [\n {\n \"computedUrl\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"computedUrl\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"folder\": \"\",\n \"tokens\": [\n {\n \"computedUrl\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"computedUrl\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "81bb29f5-61be-4e50-bd1d-b0f0601a7ef8", "name": "Delete Token by Name", "request": { "name": "Delete Token by Name", "description": { "content": "Deletes a token with the given name from the parent folder. Required Permissions: Read-Write Assets", "type": "text/plain" }, "url": { "path": [ "rest", "asset", "v1", "folder", ":id", "tokens", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "folderType", "value": "Program" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "type", "value": "" } ] }, "auth": null }, "response": [ { "id": "98398d21-f38c-431c-880a-ec1759c78bea", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "asset", "v1", "folder", ":id", "tokens", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "folderType", "value": "Program" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "type", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"result\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"success\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "User Management", "item": [ { "name": "User Management", "description": "CRUD operations on Marketo Engage users, roles, workspaces, and user invitations.", "item": [ { "id": "3bdae7dd-9045-464d-ac09-5dc4c1e8da00", "name": "Get Users", "request": { "name": "Get Users", "description": { "content": "Retrieve a list of all user records. Required Permissions: Access User Management Api and Access Users", "type": "text/plain" }, "url": { "path": [ "userservice", "management", "v1", "users", "allusers.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Integer offset for paging. Default is 0", "type": "text/plain" }, "key": "pageOffset", "value": "0" }, { "disabled": true, "description": { "content": "Maximum number of users to return. Max 200, default 20", "type": "text/plain" }, "key": "pageSize", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b4a2ea9f-f10d-4c35-975a-a3971c34a749", "name": "OK", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", "allusers.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Integer offset for paging. Default is 0", "type": "text/plain" }, "key": "pageOffset", "value": "0" }, { "disabled": true, "description": { "content": "Maximum number of users to return. Max 200, default 20", "type": "text/plain" }, "key": "pageSize", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"userid\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"apiOnly\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"userid\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"apiOnly\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "597ea51f-e106-425a-aa75-cebd390beaf7", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", "allusers.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Integer offset for paging. Default is 0", "type": "text/plain" }, "key": "pageOffset", "value": "0" }, { "disabled": true, "description": { "content": "Maximum number of users to return. Max 200, default 20", "type": "text/plain" }, "key": "pageSize", "value": "20" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "70f6fbc2-d2cf-466e-8f85-65aa91de8225", "name": "Forbidden", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", "allusers.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Integer offset for paging. Default is 0", "type": "text/plain" }, "key": "pageOffset", "value": "0" }, { "disabled": true, "description": { "content": "Maximum number of users to return. Max 200, default 20", "type": "text/plain" }, "key": "pageSize", "value": "20" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8dc304d7-cc44-4321-8ac6-aec9d391872b", "name": "Not Found", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", "allusers.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Integer offset for paging. Default is 0", "type": "text/plain" }, "key": "pageOffset", "value": "0" }, { "disabled": true, "description": { "content": "Maximum number of users to return. Max 200, default 20", "type": "text/plain" }, "key": "pageSize", "value": "20" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "02dd9c69-6d1d-4fcd-9f8d-e11f0d1b8207", "name": "Invite User", "request": { "name": "Invite User", "description": { "content": "Send an email invitation to new user. Required Permissions: Access User Management Api and Access Users", "type": "text/plain" }, "url": { "path": [ "userservice", "management", "v1", "users", "invite.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"emailAddress\": \"E{!V?D0OQ@pP3f4mSQTcq.cWYOnBpdKVF\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"userRoleWorkspaces\": [\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\"\n },\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\"\n }\n ],\n \"apiOnly\": \"\",\n \"expiresAt\": \"\",\n \"userid\": \"\",\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "012fce2a-7c2e-486e-a5a5-06a8d5beed25", "name": "OK", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", "invite.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"emailAddress\": \"E{!V?D0OQ@pP3f4mSQTcq.cWYOnBpdKVF\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"userRoleWorkspaces\": [\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\"\n },\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\"\n }\n ],\n \"apiOnly\": \"\",\n \"expiresAt\": \"\",\n \"userid\": \"\",\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68441466-46e8-4ba3-ad31-903a6c1eac7b", "name": "Created", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", "invite.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"emailAddress\": \"E{!V?D0OQ@pP3f4mSQTcq.cWYOnBpdKVF\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"userRoleWorkspaces\": [\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\"\n },\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\"\n }\n ],\n \"apiOnly\": \"\",\n \"expiresAt\": \"\",\n \"userid\": \"\",\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "95cc1322-147a-4fe6-8a46-f43b7cb51581", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", "invite.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"emailAddress\": \"E{!V?D0OQ@pP3f4mSQTcq.cWYOnBpdKVF\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"userRoleWorkspaces\": [\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\"\n },\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\"\n }\n ],\n \"apiOnly\": \"\",\n \"expiresAt\": \"\",\n \"userid\": \"\",\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0927e93a-bb9e-4cfd-b713-81d1289ddded", "name": "Forbidden", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", "invite.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"emailAddress\": \"E{!V?D0OQ@pP3f4mSQTcq.cWYOnBpdKVF\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"userRoleWorkspaces\": [\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\"\n },\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\"\n }\n ],\n \"apiOnly\": \"\",\n \"expiresAt\": \"\",\n \"userid\": \"\",\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dc60e4ef-0bd9-4a6b-bda0-c784f7933801", "name": "Not Found", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", "invite.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"emailAddress\": \"E{!V?D0OQ@pP3f4mSQTcq.cWYOnBpdKVF\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"userRoleWorkspaces\": [\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\"\n },\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\"\n }\n ],\n \"apiOnly\": \"\",\n \"expiresAt\": \"\",\n \"userid\": \"\",\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "40efa17d-88c0-4a19-ace3-0fb09a1ca9ec", "name": "Get Roles", "request": { "name": "Get Roles", "description": { "content": "Retrieve list of all role records. Required Permissions: Access User Management Api and Access Users", "type": "text/plain" }, "url": { "path": [ "userservice", "management", "v1", "users", "roles.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d62d337e-eafd-47f8-9682-8aeb1a57c89d", "name": "OK", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", "roles.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"description\": \"\",\n \"id\": \"\",\n \"isHidden\": \"\",\n \"isOnlyAllZones\": \"\",\n \"name\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"type\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"isHidden\": \"\",\n \"isOnlyAllZones\": \"\",\n \"name\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"type\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2dacfae7-0518-4774-86e6-b1b7b4ee7331", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", "roles.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b3414bd9-7c03-40c1-87e9-5721a94bdf66", "name": "Forbidden", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", "roles.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "02974481-3bbb-4e37-b4eb-8b187d0a7285", "name": "Not Found", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", "roles.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "81d1b6a6-6ea6-48eb-bea5-4b774f75e0de", "name": "Get Workspaces", "request": { "name": "Get Workspaces", "description": { "content": "Retrieve list of workspace records. Required Permissions: Access User Management Api and Access Users", "type": "text/plain" }, "url": { "path": [ "userservice", "management", "v1", "users", "workspaces.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d66e9c1d-5be7-4eab-a9da-397a17af0689", "name": "OK", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", "workspaces.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"currencyInfo\": \"\",\n \"description\": \"\",\n \"globalViz\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"currencyInfo\": \"\",\n \"description\": \"\",\n \"globalViz\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "792e3679-4921-4c99-bd35-1dd96c7d7265", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", "workspaces.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c0413319-3ea9-4ae1-b02d-5164377dd980", "name": "Forbidden", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", "workspaces.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a7c8ccf0-b95f-4fb5-be8f-9d353da5adc7", "name": "Not Found", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", "workspaces.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3ffad529-d796-48fd-ae7e-846459283a67", "name": "Delete User", "request": { "name": "Delete User", "description": { "content": "Delete user. Required Permissions: Access User Management Api and Access Users", "type": "text/plain" }, "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "userid", "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" } } ] }, "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "0b0307f4-4adf-44d8-a1e6-283411260459", "name": "OK", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" }, "type": "any", "value": "", "key": "userid" } ] }, "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "64d6f5d0-188d-45d6-bcc1-57e37f27d374", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" }, "type": "any", "value": "", "key": "userid" } ] }, "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "16dbf9f3-8b14-406d-a94a-d72790140995", "name": "Forbidden", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" }, "type": "any", "value": "", "key": "userid" } ] }, "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "efb20a7f-e046-4c4b-b5e7-39752d98a8e7", "name": "Not Found", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" }, "type": "any", "value": "", "key": "userid" } ] }, "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "18458d5c-767e-4c01-8057-2c737de54bb1", "name": "Get Invited User by Id", "request": { "name": "Get Invited User by Id", "description": { "content": "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", "type": "text/plain" }, "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "invite.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "userid", "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "cbeb2634-5e31-461d-b82d-9f48a4848d3b", "name": "OK", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "invite.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" }, "type": "any", "value": "", "key": "userid" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"emailAddress\": \"\",\n \"userid\": \"\",\n \"subscriptionId\": \"\",\n \"status\": \"pending\",\n \"expiresAt\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b6c88cb-a5b4-4360-9998-48e2044fa1d9", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "invite.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" }, "type": "any", "value": "", "key": "userid" } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "60126a7b-fe69-4dbc-b845-0ed28c3a7396", "name": "Forbidden", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "invite.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" }, "type": "any", "value": "", "key": "userid" } ] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9bb93f5f-5741-4de9-a9f1-a5771de38ae1", "name": "Not Found", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "invite.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" }, "type": "any", "value": "", "key": "userid" } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7ac467ee-27c1-476f-a643-20a1c5b7ef6f", "name": "Delete Invited User", "request": { "name": "Delete Invited User", "description": { "content": "Delete pending user. A pending user is a user that has not yet accepted invitation. Required Permissions: Access User Management Api and Access Users", "type": "text/plain" }, "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "invite", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "userid", "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" } } ] }, "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "98fc9eba-59c4-4cd6-bed5-e05357a3ce4f", "name": "OK", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "invite", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" }, "type": "any", "value": "", "key": "userid" } ] }, "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "037b2c83-1873-47b0-9f14-e2adec2e56dc", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "invite", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" }, "type": "any", "value": "", "key": "userid" } ] }, "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e06666d5-c5ea-46dc-9a26-d78cdfa98d18", "name": "Forbidden", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "invite", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" }, "type": "any", "value": "", "key": "userid" } ] }, "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0a9c34bc-0395-4ca1-8534-0430c4d29d52", "name": "Not Found", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "invite", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" }, "type": "any", "value": "", "key": "userid" } ] }, "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2cbcbc6d-71bf-47ff-9c6e-7a3a46cabc9b", "name": "Get Roles and Workspaces by Id", "request": { "name": "Get Roles and Workspaces by Id", "description": { "content": "Get roles and workspaces for a given user. Required Permissions: Access User Management Api and Access Users", "type": "text/plain" }, "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "roles.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "userid", "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0ea8c545-f1ab-4ceb-85a1-5d02f49784e6", "name": "OK", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "roles.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" }, "type": "any", "value": "", "key": "userid" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\",\n \"accessRoleName\": \"\",\n \"workspaceName\": \"\"\n },\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\",\n \"accessRoleName\": \"\",\n \"workspaceName\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c0b05c5-a137-4f5a-aa19-2a2be85043f0", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "roles.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" }, "type": "any", "value": "", "key": "userid" } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "505cdae5-571a-4c01-9c85-d32fcfcdefac", "name": "Forbidden", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "roles.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" }, "type": "any", "value": "", "key": "userid" } ] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d6c73732-085c-42e7-aeee-ec54e0ee91ee", "name": "Not Found", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "roles.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" }, "type": "any", "value": "", "key": "userid" } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "61b7f828-352f-419e-bd23-eb3a2b4d506d", "name": "Add Roles", "request": { "name": "Add Roles", "description": { "content": "Add roles to a user. Required Permissions: Access User Management Api and Access Users", "type": "text/plain" }, "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "roles", "create.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "userid", "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\"\n },\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7abeccef-3cb0-4003-bf27-f7ba08f3cc65", "name": "OK", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "roles", "create.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" }, "type": "any", "value": "", "key": "userid" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\"\n },\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\",\n \"accessRoleName\": \"\",\n \"workspaceName\": \"\"\n },\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\",\n \"accessRoleName\": \"\",\n \"workspaceName\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c07ebe4d-89b7-4afa-b740-8bd80272598d", "name": "Created", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "roles", "create.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" }, "type": "any", "value": "", "key": "userid" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\"\n },\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a81014e4-545d-4bd8-a0df-c4d9d82701e0", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "roles", "create.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" }, "type": "any", "value": "", "key": "userid" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\"\n },\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ad388ec8-ae5b-4071-bfe7-9d18dd72e3cb", "name": "Forbidden", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "roles", "create.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" }, "type": "any", "value": "", "key": "userid" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\"\n },\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f3fbe55b-9bdf-4daa-b75a-5b0c07826bd0", "name": "Not Found", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "roles", "create.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" }, "type": "any", "value": "", "key": "userid" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\"\n },\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6f722f9f-f62f-4da8-ad31-e91d7019b04d", "name": "Delete Roles", "request": { "name": "Delete Roles", "description": { "content": "Delete roles from user. Required Permissions: Access User Management Api and Access Users", "type": "text/plain" }, "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "roles", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "userid", "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\"\n },\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "71ed0743-2710-44e9-802b-9301ab857727", "name": "OK", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "roles", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" }, "type": "any", "value": "", "key": "userid" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\"\n },\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\",\n \"accessRoleName\": \"\",\n \"workspaceName\": \"\"\n },\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\",\n \"accessRoleName\": \"\",\n \"workspaceName\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "893188cc-3a56-443b-baf3-ab9753456dea", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "roles", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" }, "type": "any", "value": "", "key": "userid" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\"\n },\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "982031b8-4806-4ddd-90f7-a26487560ff5", "name": "Forbidden", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "roles", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" }, "type": "any", "value": "", "key": "userid" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\"\n },\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d34a2626-a61d-48e3-acad-8402c30b551c", "name": "Not Found", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "roles", "delete.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" }, "type": "any", "value": "", "key": "userid" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"input\": [\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\"\n },\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5a18b84f-6b63-4ab6-bd85-ba07e4eb6f36", "name": "Update User Attributes", "request": { "name": "Update User Attributes", "description": { "content": "Update one or more user attributes. Required Permissions: Access User Management Api and Access Users", "type": "text/plain" }, "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "update.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "userid", "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apiOnly\": \"\",\n \"emailAddress\": \"\\\"1{eWOz~mX\\\"@Y0JHbN.fbhU2GSntTuprsrUq47Ex.Ibl2QarjIoHlQ08EGv45fpeVLAXDav53hKfmlg-rre9JLN_0rfPNqeUl.AfxqdOXlW97YDTK9onFjdBYJy7ht_Bn3Q1QQ4R9pgK0kK64MC6K2N1QkIdVU.n0dgHC3pkF4NH4l_u9l1pk2jtT9-4A-W-6j3UYbzccU4r-CK.4w-8ktXkJ1x.8w0EWKZieprmCL.ekKaKrrQ\",\n \"expiresAt\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a0783548-8395-49f9-812a-f0532b1962a8", "name": "OK", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "update.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" }, "type": "any", "value": "", "key": "userid" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apiOnly\": \"\",\n \"emailAddress\": \"\\\"1{eWOz~mX\\\"@Y0JHbN.fbhU2GSntTuprsrUq47Ex.Ibl2QarjIoHlQ08EGv45fpeVLAXDav53hKfmlg-rre9JLN_0rfPNqeUl.AfxqdOXlW97YDTK9onFjdBYJy7ht_Bn3Q1QQ4R9pgK0kK64MC6K2N1QkIdVU.n0dgHC3pkF4NH4l_u9l1pk2jtT9-4A-W-6j3UYbzccU4r-CK.4w-8ktXkJ1x.8w0EWKZieprmCL.ekKaKrrQ\",\n \"expiresAt\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"userid\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"emailAddress\": \"\",\n \"optedIn\": \"\",\n \"failedLogins\": \"\",\n \"failedDeviceCode\": \"\",\n \"isLocked\": \"\",\n \"lockedReason\": \"\",\n \"id\": \"\",\n \"apiOnly\": \"\",\n \"userRoleWorkspaces\": [\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\",\n \"accessRoleName\": \"\",\n \"workspaceName\": \"\"\n },\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\",\n \"accessRoleName\": \"\",\n \"workspaceName\": \"\"\n }\n ],\n \"expiresAt\": \"\",\n \"lastLoginAt\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6644047a-34aa-4d85-aed9-de2e66d62bd2", "name": "Created", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "update.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" }, "type": "any", "value": "", "key": "userid" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apiOnly\": \"\",\n \"emailAddress\": \"\\\"1{eWOz~mX\\\"@Y0JHbN.fbhU2GSntTuprsrUq47Ex.Ibl2QarjIoHlQ08EGv45fpeVLAXDav53hKfmlg-rre9JLN_0rfPNqeUl.AfxqdOXlW97YDTK9onFjdBYJy7ht_Bn3Q1QQ4R9pgK0kK64MC6K2N1QkIdVU.n0dgHC3pkF4NH4l_u9l1pk2jtT9-4A-W-6j3UYbzccU4r-CK.4w-8ktXkJ1x.8w0EWKZieprmCL.ekKaKrrQ\",\n \"expiresAt\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "02d3ad4e-fc1d-4f2c-8080-4745a25ef5a3", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "update.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" }, "type": "any", "value": "", "key": "userid" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apiOnly\": \"\",\n \"emailAddress\": \"\\\"1{eWOz~mX\\\"@Y0JHbN.fbhU2GSntTuprsrUq47Ex.Ibl2QarjIoHlQ08EGv45fpeVLAXDav53hKfmlg-rre9JLN_0rfPNqeUl.AfxqdOXlW97YDTK9onFjdBYJy7ht_Bn3Q1QQ4R9pgK0kK64MC6K2N1QkIdVU.n0dgHC3pkF4NH4l_u9l1pk2jtT9-4A-W-6j3UYbzccU4r-CK.4w-8ktXkJ1x.8w0EWKZieprmCL.ekKaKrrQ\",\n \"expiresAt\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2143cebb-99bf-4fa2-b0d9-387e1866836b", "name": "Forbidden", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "update.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" }, "type": "any", "value": "", "key": "userid" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apiOnly\": \"\",\n \"emailAddress\": \"\\\"1{eWOz~mX\\\"@Y0JHbN.fbhU2GSntTuprsrUq47Ex.Ibl2QarjIoHlQ08EGv45fpeVLAXDav53hKfmlg-rre9JLN_0rfPNqeUl.AfxqdOXlW97YDTK9onFjdBYJy7ht_Bn3Q1QQ4R9pgK0kK64MC6K2N1QkIdVU.n0dgHC3pkF4NH4l_u9l1pk2jtT9-4A-W-6j3UYbzccU4r-CK.4w-8ktXkJ1x.8w0EWKZieprmCL.ekKaKrrQ\",\n \"expiresAt\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e0eaa983-6a1a-4504-b186-dbe50aba3706", "name": "Not Found", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "update.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" }, "type": "any", "value": "", "key": "userid" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apiOnly\": \"\",\n \"emailAddress\": \"\\\"1{eWOz~mX\\\"@Y0JHbN.fbhU2GSntTuprsrUq47Ex.Ibl2QarjIoHlQ08EGv45fpeVLAXDav53hKfmlg-rre9JLN_0rfPNqeUl.AfxqdOXlW97YDTK9onFjdBYJy7ht_Bn3Q1QQ4R9pgK0kK64MC6K2N1QkIdVU.n0dgHC3pkF4NH4l_u9l1pk2jtT9-4A-W-6j3UYbzccU4r-CK.4w-8ktXkJ1x.8w0EWKZieprmCL.ekKaKrrQ\",\n \"expiresAt\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "483e330e-56de-4df0-a284-71864248754c", "name": "Get User by Id", "request": { "name": "Get User by Id", "description": { "content": "Retrieve a single user record through its Id. Required Permissions: Access User Management Api and Access Users", "type": "text/plain" }, "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "user.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "userid", "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d42ec7c8-b8b6-4eb3-b897-2ccf0b34c380", "name": "OK", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "user.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" }, "type": "any", "value": "", "key": "userid" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"userid\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"emailAddress\": \"\",\n \"optedIn\": \"\",\n \"failedLogins\": \"\",\n \"failedDeviceCode\": \"\",\n \"isLocked\": \"\",\n \"lockedReason\": \"\",\n \"id\": \"\",\n \"apiOnly\": \"\",\n \"userRoleWorkspaces\": [\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\",\n \"accessRoleName\": \"\",\n \"workspaceName\": \"\"\n },\n {\n \"accessRoleId\": \"\",\n \"workspaceId\": \"\",\n \"accessRoleName\": \"\",\n \"workspaceName\": \"\"\n }\n ],\n \"expiresAt\": \"\",\n \"lastLoginAt\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b04bdfe9-fdab-4273-ae06-9f2bdc09648d", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "user.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" }, "type": "any", "value": "", "key": "userid" } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "10484e87-eb93-4ac7-91eb-c57a0e6efcc2", "name": "Forbidden", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "user.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" }, "type": "any", "value": "", "key": "userid" } ] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c215f289-c2e2-4d1e-8dde-6fc06162a44b", "name": "Not Found", "originalRequest": { "url": { "path": [ "userservice", "management", "v1", "users", ":userid", "user.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) User id in the form of an email address", "type": "text/plain" }, "type": "any", "value": "", "key": "userid" } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Marketo OAuth 2.0 -- fetches and caches an access token automatically.", "//", "// Tokens last one hour. This refreshes 60s before expiry and stores the result", "// in `access_token`, which the collection-level Bearer auth uses. You never", "// need to run the Identity request by hand.", "// --- variable scope helpers ------------------------------------------------", "// Postman resolves {{placeholders}} in this order:", "// local -> data -> ENVIRONMENT -> COLLECTION -> global", "// So if an environment defines `access_token` (even as an empty string), it", "// shadows any collection variable of the same name. Token state therefore has", "// to be written to whichever scope the {{access_token}} lookup reaches first,", "// and read through pm.variables, which walks the whole chain.", "", "function readVar(key) {", " return pm.variables.get(key);", "}", "", "function writeVar(key, value) {", " var useEnv = false;", " try {", " useEnv = Boolean(pm.environment.name) || pm.environment.has(key);", " } catch (e) {", " useEnv = false;", " }", " if (useEnv) {", " pm.environment.set(key, value);", " } else {", " pm.collectionVariables.set(key, value);", " }", "}", "", "// ---------------------------------------------------------------------------", "", "const TOKEN_PATH = '/identity/oauth/token';", "const url = pm.request.url.toString();", "", "function tokenNeeded() {", " // Don't recurse when the request being sent IS the token request.", " if (url.indexOf(TOKEN_PATH) !== -1) { return false; }", " const token = readVar('access_token');", " const expiresAt = Number(readVar('token_expires_at') || 0);", " return !token || Date.now() > (expiresAt - 60000);", "}", "", "function configured(value) {", " return value && value.indexOf('{{') === -1 && value.indexOf('<') !== 0;", "}", "", "if (tokenNeeded()) {", " const baseUrl = pm.variables.replaceIn('{{baseUrl}}');", " const clientId = pm.variables.replaceIn('{{client_id}}');", " const clientSecret = pm.variables.replaceIn('{{client_secret}}');", "", " if (!configured(clientId) || !configured(clientSecret)) {", " console.warn(", " 'Marketo: set client_id and client_secret (Admin > Integration > LaunchPoint) ' +", " 'and munchkinId (Admin > Web Services) before sending requests.'", " );", " } else {", " pm.sendRequest({", " url: baseUrl + TOKEN_PATH +", " '?grant_type=client_credentials' +", " '&client_id=' + encodeURIComponent(clientId) +", " '&client_secret=' + encodeURIComponent(clientSecret),", " method: 'GET'", " }, function (err, res) {", " if (err) {", " console.error('Marketo: token request failed', err);", " return;", " }", " let body;", " try { body = res.json(); } catch (e) { body = {}; }", " if (!body.access_token) {", " console.error('Marketo: no token returned', body);", " return;", " }", " const ttl = (Number(body.expires_in) || 3600) * 1000;", " writeVar('access_token', body.access_token);", " writeVar('token_expires_at', String(Date.now() + ttl));", " console.log('Marketo: got a new access token (expires in ' + body.expires_in + 's)');", " });", " }", "}", "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "// Marketo answers almost every request with HTTP 200 and reports failure in the", "// body, so a green status code means very little on its own.", "// --- variable scope helpers ------------------------------------------------", "// Postman resolves {{placeholders}} in this order:", "// local -> data -> ENVIRONMENT -> COLLECTION -> global", "// So if an environment defines `access_token` (even as an empty string), it", "// shadows any collection variable of the same name. Token state therefore has", "// to be written to whichever scope the {{access_token}} lookup reaches first,", "// and read through pm.variables, which walks the whole chain.", "", "function readVar(key) {", " return pm.variables.get(key);", "}", "", "function writeVar(key, value) {", " var useEnv = false;", " try {", " useEnv = Boolean(pm.environment.name) || pm.environment.has(key);", " } catch (e) {", " useEnv = false;", " }", " if (useEnv) {", " pm.environment.set(key, value);", " } else {", " pm.collectionVariables.set(key, value);", " }", "}", "", "// ---------------------------------------------------------------------------", "", "pm.test('HTTP status is a success code', function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201, 204, 206]);", "});", "", "let body = null;", "try { body = pm.response.json(); } catch (e) { /* CSV exports, file downloads */ }", "", "if (body && typeof body.success !== 'undefined') {", " pm.test('Response envelope reports success', function () {", " if (body.success !== true) {", " const detail = (body.errors || [])", " .map(function (e) { return '[' + e.code + '] ' + e.message; })", " .join('; ');", " throw new Error(detail || 'success: false with no errors array');", " }", " });", "", " if (Array.isArray(body.warnings) && body.warnings.length) {", " console.warn('Marketo warnings:', body.warnings);", " }", "", " // Per-record failures can hide inside a successful response.", " if (Array.isArray(body.result)) {", " const failed = body.result.filter(function (r) {", " return r && (r.status === 'skipped' || (r.reasons && r.reasons.length));", " });", " if (failed.length) {", " console.warn('Marketo: ' + failed.length + ' record(s) were skipped', failed);", " }", " }", "", " // Carry paging state forward: re-send the same request to walk the next page.", " if (body.nextPageToken) {", " writeVar('nextPageToken', body.nextPageToken);", " }", " if (body.moreResult === false) {", " writeVar('nextPageToken', '');", " }", "}", "", "// Capture the token when this request IS the Identity call.", "if (body && body.access_token) {", " const ttl = (Number(body.expires_in) || 3600) * 1000;", " writeVar('access_token', body.access_token);", " writeVar('token_expires_at', String(Date.now() + ttl));", "}", "" ] } } ], "variable": [ { "key": "munchkinId", "value": "123-ABC-456", "type": "string", "description": "Your instance's Munchkin ID (Admin > Web Services)" }, { "key": "baseUrl", "value": "https://{{munchkinId}}.mktorest.com", "type": "string", "description": "REST endpoint host. Override only if you use a custom API domain." }, { "key": "client_id", "value": "", "type": "string", "description": "LaunchPoint custom service Client ID" }, { "key": "client_secret", "value": "", "type": "string", "description": "LaunchPoint custom service Client Secret" }, { "key": "access_token", "value": "", "type": "string", "description": "Set automatically by the pre-request script. Leave blank." }, { "key": "token_expires_at", "value": "0", "type": "string", "description": "Set automatically by the pre-request script. Leave blank." }, { "key": "nextPageToken", "value": "", "type": "string", "description": "Set automatically from the last paged response." }, { "key": "apiName", "value": "", "type": "string" }, { "key": "batchId", "value": "", "type": "string" }, { "key": "campaignId", "value": "", "type": "string" }, { "key": "contentId", "value": "", "type": "string" }, { "key": "customObjectName", "value": "", "type": "string" }, { "key": "fieldApiName", "value": "", "type": "string" }, { "key": "fieldId", "value": "", "type": "string" }, { "key": "htmlId", "value": "", "type": "string" }, { "key": "id", "value": "", "type": "string" }, { "key": "leadId", "value": "", "type": "string" }, { "key": "listId", "value": "", "type": "string" }, { "key": "name", "value": "", "type": "string" }, { "key": "programId", "value": "", "type": "string" }, { "key": "segmentId", "value": "", "type": "string" }, { "key": "variableId", "value": "", "type": "string" } ], "info": { "name": "Adobe Marketo Engage REST API (Unofficial)", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Unofficial Postman collection for the **Adobe Marketo Engage REST API** \u2014 all 360 endpoints across Identity, Lead Database & Marketing Activities, Asset, and User Management.\n\nGenerated from the [OpenAPI 3 definition](https://github.com/jdarring/marketo-openapi) for the same API, so the two never drift apart.\n\n## Setup\n\nSet three variables, either on the collection or in the bundled environment:\n\n| Variable | Where to find it |\n| --- | --- |\n| `munchkinId` | Admin \u2192 Web Services. The `123-ABC-456` part of your REST endpoint. |\n| `client_id` | Admin \u2192 Integration \u2192 LaunchPoint \u2192 your custom service \u2192 View Details |\n| `client_secret` | Same place |\n\nThat's it. **You do not need to fetch a token by hand** \u2014 a collection-level pre-request script gets one on the first call, caches it in `access_token`, and refreshes it 60 seconds before it expires. The Identity folder is there if you want to inspect the exchange yourself.\n\n`access_token` and `token_expires_at` are written to whichever scope is active (your environment if one is selected, otherwise the collection) and appear there after the first call. Don't add empty copies of them to an environment by hand \u2014 an environment variable shadows the collection variable of the same name, which would blank out the token before it reaches the Authorization header.\n\n## What the scripts do for you\n\n- **Auth.** Every request inherits Bearer auth from the collection, backed by the auto-refreshed `access_token`.\n- **Real error checking.** Marketo returns HTTP 200 even when a call fails, reporting the problem as `success: false` with an `errors` array. The collection test script fails the request in that case and prints the Marketo error codes, so the Collection Runner tells you the truth.\n- **Paging.** Any returned `nextPageToken` is saved to a collection variable of the same name. Requests that accept it are pre-wired to `{{nextPageToken}}`, so re-sending walks the next page.\n- **Skipped records.** Batch calls can return `success: true` with individual records rejected; those get logged to the Postman console.\n\n## Conventions\n\n- Placeholder values look like `` or `` \u2014 replace them before sending.\n- Optional query parameters ship disabled. Tick the ones you need.\n- Asset write endpoints (`Emails`, `Forms`, `Landing Pages`, \u2026) take `application/x-www-form-urlencoded` bodies, not JSON. Lead Database writes take JSON. The requests are already set up correctly; keep it that way when you edit them.\n- Rate limits: 100 calls per 20 seconds, 10 concurrent, 50,000/day by default. Add a delay in the Collection Runner before running a whole folder.\n\nFull reference: , or Adobe's own docs at .\n", "type": "text/markdown" } } }